CustomMessageActivity cUSTOM
The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.
ConditionalSplitActivity conditionalSplit
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.
String description
The custom description of the activity.
EmailMessageActivity eMAIL
The settings for an email activity. This type of activity sends an email message to participants.
HoldoutActivity holdout
The settings for a holdout activity. This type of activity stops a journey for a specified percentage of participants.
MultiConditionalSplitActivity multiCondition
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.
PushMessageActivity pUSH
The settings for a push notification activity. This type of activity sends a push notification to participants.
RandomSplitActivity randomSplit
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.
SMSMessageActivity sMS
The settings for an SMS activity. This type of activity sends a text message to participants.
WaitActivity wait
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.
ContactCenterActivity contactCenter
The settings for a connect activity. This type of activity initiates a contact center call to participants.
String applicationId
The unique identifier for the application that the campaign applies to.
String campaignId
The unique identifier for the campaign that the activity applies to.
String end
The actual time, in ISO 8601 format, when the activity was marked CANCELLED or COMPLETED.
String id
The unique identifier for the activity.
String result
Specifies whether the activity succeeded. Possible values are SUCCESS and FAIL.
String scheduledStart
The scheduled start time, in ISO 8601 format, for the activity.
String start
The actual start time, in ISO 8601 format, of the activity.
String state
The current status of the activity. Possible values are: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, and COMPLETED.
Integer successfulEndpointCount
The total number of endpoints that the campaign successfully delivered messages to.
Integer timezonesCompletedCount
The total number of time zones that were completed.
Integer timezonesTotalCount
The total number of unique time zones that are in the segment for the campaign.
Integer totalEndpointCount
The total number of endpoints that the campaign attempted to deliver messages to.
String treatmentId
The unique identifier for the campaign treatment that the activity applies to. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
Map<K,V> executionMetrics
A JSON object that contains metrics relating to the campaign execution for this campaign activity. For information about the structure and contents of the results, see Standard Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer Guide.
String bodyOverride
The message body to use instead of the default message body. This value overrides the default message body.
String channelType
The channel to use when sending the message.
Map<K,V> context
An object that maps custom attributes to attributes for the address and is attached to the message. Attribute names are case sensitive.
For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.
String rawContent
The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides all other values for the message.
Map<K,V> substitutions
A map of the message variables to merge with the variables specified by properties of the DefaultMessage object. The variables specified in this map take precedence over all other variables.
String titleOverride
The message title to use instead of the default message title. This value overrides the default message title.
String clientId
The Client ID that you received from Amazon to send messages by using ADM.
String clientSecret
The Client Secret that you received from Amazon to send messages by using ADM.
Boolean enabled
Specifies whether to enable the ADM channel for the application.
String applicationId
The unique identifier for the application that the ADM channel applies to.
String creationDate
The date and time when the ADM channel was enabled.
Boolean enabled
Specifies whether the ADM channel is enabled for the application.
Boolean hasCredential
(Not used) This property is retained only for backward compatibility.
String id
(Deprecated) An identifier for the ADM channel. This property is retained only for backward compatibility.
Boolean isArchived
Specifies whether the ADM channel is archived.
String lastModifiedBy
The user who last modified the ADM channel.
String lastModifiedDate
The date and time when the ADM channel was last modified.
String platform
The type of messaging or notification platform for the channel. For the ADM channel, this value is ADM.
Integer version
The current version of the ADM channel.
String action
The action to occur if the 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 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.
String body
The body of the notification message.
String consolidationKey
An arbitrary string that indicates that multiple messages are logically the same and that Amazon Device Messaging (ADM) can drop previously enqueued messages in favor of this message.
Map<K,V> data
The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
String expiresAfter
The amount of time, in seconds, that ADM should store the message if the recipient's device is offline. Amazon Pinpoint specifies this value in the expiresAfter parameter when it sends the notification message to ADM.
String iconReference
The icon image name of the asset saved in your app.
String imageIconUrl
The URL of the large icon image to display in the content view of the push notification.
String imageUrl
The URL of an image to display in the push notification.
String mD5
The base64-encoded, MD5 checksum of the value specified by the Data property. ADM uses the MD5 value to verify the integrity of the data.
String rawContent
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.
Boolean silentPush
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 or supporting phone home functionality.
String smallImageIconUrl
The URL of the small icon image to display in the status bar and the content view of the push notification.
String sound
The sound to play when the recipient receives the push notification. 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/.
Map<K,V> substitutions
The default message variables to use in the notification message. You can override the default variables with individual address variables.
String title
The title to display above the notification message on the recipient's device.
String url
The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
String action
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.
String body
The message body to use in a push notification that's based on the message template.
String imageIconUrl
The URL of the large icon image to display in the content view of a push notification that's based on the message template.
String imageUrl
The URL of an image to display in a push notification that's based on the message template.
String rawContent
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.
String smallImageIconUrl
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.
String sound
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/.
String title
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.
String url
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.
String bundleId
The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.
String certificate
The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate.
String defaultAuthenticationMethod
The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate.
Boolean enabled
Specifies whether to enable the APNs channel for the application.
String privateKey
The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.
String teamId
The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.
String tokenKey
The authentication key to use for APNs tokens.
String tokenKeyId
The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with APNs by using APNs tokens.
String applicationId
The unique identifier for the application that the APNs channel applies to.
String creationDate
The date and time when the APNs channel was enabled.
String defaultAuthenticationMethod
The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate.
Boolean enabled
Specifies whether the APNs channel is enabled for the application.
Boolean hasCredential
(Not used) This property is retained only for backward compatibility.
Boolean hasTokenKey
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.
String id
(Deprecated) An identifier for the APNs channel. This property is retained only for backward compatibility.
Boolean isArchived
Specifies whether the APNs channel is archived.
String lastModifiedBy
The user who last modified the APNs channel.
String lastModifiedDate
The date and time when the APNs channel was last modified.
String platform
The type of messaging or notification platform for the channel. For the APNs channel, this value is APNS.
Integer version
The current version of the APNs channel.
String aPNSPushType
The type of push notification to send. Valid values are:
alert - For a standard notification that's displayed on recipients' devices and prompts a recipient to interact with the notification.
background - For a silent notification that delivers content in the background and isn't displayed on recipients' devices.
complication - For a notification that contains update information for an app’s complication timeline.
fileprovider - For a notification that signals changes to a File Provider extension.
mdm - For a notification that tells managed devices to contact the MDM server.
voip - For a notification that provides information about an incoming VoIP call.
Amazon Pinpoint specifies this value in the apns-push-type request header when it sends the notification message to APNs. If you don't specify a value for this property, Amazon Pinpoint sets the value to alert or background automatically, based on the value that you specify for the SilentPush or RawContent property of the message.
For more information about the apns-push-type request header, see Sending Notification Requests to APNs on the Apple Developer website.
String action
The action to occur if the 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 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.
Integer badge
The key that indicates whether and how to modify the badge of your app's icon when the recipient receives the push notification. If this key isn't included in the dictionary, the badge doesn't change. To remove the badge, set this value to 0.
String body
The body of the notification message.
String category
The key that indicates the notification type for the push notification. This key is a value that's defined by the identifier property of one of your app's registered categories.
String collapseId
An arbitrary identifier that, if assigned to multiple messages, APNs uses to coalesce the messages into a single push notification instead of delivering each message individually. This value can't exceed 64 bytes.
Amazon Pinpoint specifies this value in the apns-collapse-id request header when it sends the notification message to APNs.
Map<K,V> data
The JSON payload to use for a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
String mediaUrl
The URL of an image or video to display in the push notification.
String preferredAuthenticationMethod
The authentication method that you want Amazon Pinpoint to use when authenticating with APNs, CERTIFICATE or TOKEN.
String priority
para>5 - Low priority, the notification might be delayed, delivered as part of a group, or throttled.
/listitem>10 - High priority, the notification is sent immediately. This is the default value. A high priority notification should trigger an alert, play a sound, or badge your app's icon on the recipient's device.
Amazon Pinpoint specifies this value in the apns-priority request header when it sends the notification message to APNs.
The equivalent values for Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), are normal, for 5, and high, for 10. If you specify an FCM value for this property, Amazon Pinpoint accepts and converts the value to the corresponding APNs value.
String rawContent
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.
If you specify the raw content of an APNs push notification, the message payload has to include the content-available key. The value of the content-available key has to be an integer, and can only be 0 or 1. If you're sending a standard notification, set the value of content-available to 0. If you're sending a silent (background) notification, set the value of content-available to 1. Additionally, silent notification payloads can't include the alert, badge, or sound keys. For more information, see Generating a Remote Notification and Pushing Background Updates to Your App on the Apple Developer website.
Boolean silentPush
Specifies whether the notification is a silent push notification. A silent (or background) push notification isn't displayed on recipients' devices. You can use silent push notifications to make small updates to your app, or to display messages in an in-app message center.
Amazon Pinpoint uses this property to determine the correct value for the apns-push-type request header when it sends the notification message to APNs. If you specify a value of true for this property, Amazon Pinpoint sets the value for the apns-push-type header field to background.
If you specify the raw content of an APNs push notification, the message payload has to include the content-available key. For silent (background) notifications, set the value of content-available to 1. Additionally, the message payload for a silent notification can't include the alert, badge, or sound keys. For more information, see Generating a Remote Notification and Pushing Background Updates to Your App on the Apple Developer website.
Apple has indicated that they will throttle "excessive" background notifications based on current traffic volumes. To prevent your notifications being throttled, Apple recommends that you send no more than 3 silent push notifications to each recipient per hour.
String sound
The key for the sound to play when the recipient receives the push notification. 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.
Map<K,V> substitutions
The default message variables to use in the notification message. You can override these default variables with individual address variables.
String threadId
The key that represents your app-specific identifier for grouping notifications. If you provide a Notification Content app extension, you can use this value to group your notifications together.
Integer timeToLive
The amount of time, in seconds, that APNs should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If this value is 0, APNs treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
Amazon Pinpoint specifies this value in the apns-expiration request header when it sends the notification message to APNs.
String title
The title to display above the notification message on the recipient's device.
String url
The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
String action
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.
String body
The message body to use in push notifications that are based on the message template.
String mediaUrl
The URL of an image or video to display in push notifications that are based on the message template.
String rawContent
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.
String sound
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.
String title
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.
String url
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.
String bundleId
The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.
String certificate
The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate.
String defaultAuthenticationMethod
The default authentication method that you want Amazon Pinpoint to use when authenticating with the APNs sandbox environment, key or certificate.
Boolean enabled
Specifies whether to enable the APNs sandbox channel for the application.
String privateKey
The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment.
String teamId
The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.
String tokenKey
The authentication key to use for APNs tokens.
String tokenKeyId
The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs tokens.
String applicationId
The unique identifier for the application that the APNs sandbox channel applies to.
String creationDate
The date and time when the APNs sandbox channel was enabled.
String defaultAuthenticationMethod
The default authentication method that Amazon Pinpoint uses to authenticate with the APNs sandbox environment for this channel, key or certificate.
Boolean enabled
Specifies whether the APNs sandbox channel is enabled for the application.
Boolean hasCredential
(Not used) This property is retained only for backward compatibility.
Boolean hasTokenKey
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.
String id
(Deprecated) An identifier for the APNs sandbox channel. This property is retained only for backward compatibility.
Boolean isArchived
Specifies whether the APNs sandbox channel is archived.
String lastModifiedBy
The user who last modified the APNs sandbox channel.
String lastModifiedDate
The date and time when the APNs sandbox channel was last modified.
String platform
The type of messaging or notification platform for the channel. For the APNs sandbox channel, this value is APNS_SANDBOX.
Integer version
The current version of the APNs sandbox channel.
String bundleId
The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.
String certificate
The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate.
String defaultAuthenticationMethod
The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate.
Boolean enabled
Specifies whether to enable the APNs VoIP channel for the application.
String privateKey
The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.
String teamId
The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.
String tokenKey
The authentication key to use for APNs tokens.
String tokenKeyId
The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with APNs by using APNs tokens.
String applicationId
The unique identifier for the application that the APNs VoIP channel applies to.
String creationDate
The date and time when the APNs VoIP channel was enabled.
String defaultAuthenticationMethod
The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate.
Boolean enabled
Specifies whether the APNs VoIP channel is enabled for the application.
Boolean hasCredential
(Not used) This property is retained only for backward compatibility.
Boolean hasTokenKey
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.
String id
(Deprecated) An identifier for the APNs VoIP channel. This property is retained only for backward compatibility.
Boolean isArchived
Specifies whether the APNs VoIP channel is archived.
String lastModifiedBy
The user who last modified the APNs VoIP channel.
String lastModifiedDate
The date and time when the APNs VoIP channel was last modified.
String platform
The type of messaging or notification platform for the channel. For the APNs VoIP channel, this value is APNS_VOIP.
Integer version
The current version of the APNs VoIP channel.
String bundleId
The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.
String certificate
The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate.
String defaultAuthenticationMethod
The default authentication method that you want Amazon Pinpoint to use when authenticating with the APNs sandbox environment for this channel, key or certificate.
Boolean enabled
Specifies whether the APNs VoIP sandbox channel is enabled for the application.
String privateKey
The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment.
String teamId
The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.
String tokenKey
The authentication key to use for APNs tokens.
String tokenKeyId
The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs tokens.
String applicationId
The unique identifier for the application that the APNs VoIP sandbox channel applies to.
String creationDate
The date and time when the APNs VoIP sandbox channel was enabled.
String defaultAuthenticationMethod
The default authentication method that Amazon Pinpoint uses to authenticate with the APNs sandbox environment for this channel, key or certificate.
Boolean enabled
Specifies whether the APNs VoIP sandbox channel is enabled for the application.
Boolean hasCredential
(Not used) This property is retained only for backward compatibility.
Boolean hasTokenKey
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.
String id
(Deprecated) An identifier for the APNs VoIP sandbox channel. This property is retained only for backward compatibility.
Boolean isArchived
Specifies whether the APNs VoIP sandbox channel is archived.
String lastModifiedBy
The user who last modified the APNs VoIP sandbox channel.
String lastModifiedDate
The date and time when the APNs VoIP sandbox channel was last modified.
String platform
The type of messaging or notification platform for the channel. For the APNs VoIP sandbox channel, this value is APNS_VOIP_SANDBOX.
Integer version
The current version of the APNs VoIP sandbox channel.
String applicationId
The unique identifier for the application that the metric applies to.
Date endTime
The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
String kpiName
The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.
BaseKpiResult kpiResult
An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.
String nextToken
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Application Metrics resource because the resource returns all results in a single page.
Date startTime
The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
String arn
The Amazon Resource Name (ARN) of the application.
String id
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
String name
The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console.
Map<K,V> tags
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 creationDate
The date and time when the Application was created.
Integer dailyCap
The daily number of messages that an endpoint can receive from all journeys. The maximum value is 100. If set to 0, this limit will not apply.
JourneyTimeframeCap timeframeCap
The default maximum number of messages that can be sent to an endpoint during the specified timeframe for all journeys.
Integer totalCap
The default maximum number of messages that a single journey can sent to a single endpoint. The maximum value is 100. If set to 0, this limit will not apply.
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
CampaignHook campaignHook
The settings for the AWS Lambda function to invoke by default as a code hook for campaigns in the application. You can use this hook to customize segments that are used by campaigns in the application.
String lastModifiedDate
The date and time, in ISO 8601 format, when the application's settings were last modified.
CampaignLimits limits
The default sending limits for campaigns in the application.
QuietTime quietTime
The default quiet time for campaigns in the application. Quiet time is a specific time range when messages aren't sent 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 application (or a campaign or journey that has custom quiet time settings).
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 application (or a campaign or journey that has custom quiet time settings).
If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled.
ApplicationSettingsJourneyLimits journeyLimits
The default sending limits for journeys in the application. These limits apply to each journey for the application but can be overridden, on a per journey basis, with the JourneyLimits resource.
String attributeType
The type of segment dimension to use. Valid values are:
List<E> values
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 applicationId
The unique identifier for the application.
String attributeType
The type of attribute or attributes that were removed from the endpoints. Valid values are:
endpoint-custom-attributes - Custom attributes that describe endpoints.
endpoint-metric-attributes - Custom metrics that your app reports to Amazon Pinpoint for endpoints.
endpoint-user-attributes - Custom attributes that describe users.
List<E> attributes
An array that specifies the names of the attributes that were removed from the endpoints.
String requestID
The unique identifier for the request or response.
String apiKey
The API key that you received from the Baidu Cloud Push service to communicate with the service.
Boolean enabled
Specifies whether to enable the Baidu channel for the application.
String secretKey
The secret key that you received from the Baidu Cloud Push service to communicate with the service.
String applicationId
The unique identifier for the application that the Baidu channel applies to.
String creationDate
The date and time when the Baidu channel was enabled.
String credential
The API key that you received from the Baidu Cloud Push service to communicate with the service.
Boolean enabled
Specifies whether the Baidu channel is enabled for the application.
Boolean hasCredential
(Not used) This property is retained only for backward compatibility.
String id
(Deprecated) An identifier for the Baidu channel. This property is retained only for backward compatibility.
Boolean isArchived
Specifies whether the Baidu channel is archived.
String lastModifiedBy
The user who last modified the Baidu channel.
String lastModifiedDate
The date and time when the Baidu channel was last modified.
String platform
The type of messaging or notification platform for the channel. For the Baidu channel, this value is BAIDU.
Integer version
The current version of the Baidu channel.
String action
The action to occur if the 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 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.
String body
The body of the notification message.
Map<K,V> data
The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
String iconReference
The icon image name of the asset saved in your app.
String imageIconUrl
The URL of the large icon image to display in the content view of the push notification.
String imageUrl
The URL of an image to display in the push notification.
String rawContent
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.
Boolean silentPush
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 or supporting phone home functionality.
String smallImageIconUrl
The URL of the small icon image to display in the status bar and the content view of the push notification.
String sound
The sound to play when the recipient receives the push notification. 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/.
Map<K,V> substitutions
The default message variables to use in the notification message. You can override the default variables with individual address variables.
Integer timeToLive
The amount of time, in seconds, that the Baidu Cloud Push service should store the message if the recipient's device is offline. The default value and maximum supported time is 604,800 seconds (7 days).
String title
The title to display above the notification message on the recipient's device.
String url
The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
String data
The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.
String applicationId
The unique identifier for the application that the metric applies to.
String campaignId
The unique identifier for the campaign that the metric applies to.
Date endTime
The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
String kpiName
The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.
BaseKpiResult kpiResult
An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.
String nextToken
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Campaign Metrics resource because the resource returns all results in a single page.
Date startTime
The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
String body
The body of the email for recipients whose email clients don't render HTML content.
String fromAddress
The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
List<E> headers
The list of MessageHeaders for the email. You can have up to 15 MessageHeaders for each email.
String htmlBody
The body of the email, in HTML format, for recipients whose email clients render HTML content.
String title
The subject line, or title, of the email.
EventDimensions dimensions
The dimension settings of the event filter for the campaign.
String filterType
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 (Events resource) occurs.
String lambdaFunctionName
The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.
String mode
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.
String webUrl
The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
Integer daily
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.
Integer maximumDuration
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.
Integer messagesPerSecond
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 1. The maximum value is 20,000.
Integer total
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.
Integer session
The maximum total number of messages that the campaign can send per user session.
List<E> additionalTreatments
An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.
String applicationId
The unique identifier for the application that the campaign applies to.
String arn
The Amazon Resource Name (ARN) of the campaign.
String creationDate
The date, in ISO 8601 format, when the campaign was created.
CustomDeliveryConfiguration customDeliveryConfiguration
The delivery configuration settings for sending the campaign through a custom channel.
CampaignState defaultState
The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment.
String description
The custom description of the campaign.
Integer holdoutPercent
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
CampaignHook hook
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.
String id
The unique identifier for the campaign.
Boolean isPaused
Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.
String lastModifiedDate
The date, in ISO 8601 format, when the campaign was last modified.
CampaignLimits limits
The messaging limits for the campaign.
MessageConfiguration messageConfiguration
The message configuration settings for the campaign.
String name
The name of the campaign.
Schedule schedule
The schedule settings for the campaign.
String segmentId
The unique identifier for the segment that's associated with the campaign.
Integer segmentVersion
The version number of the segment that's associated with the campaign.
CampaignState state
The current status of the campaign.
Map<K,V> tags
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.
TemplateConfiguration templateConfiguration
The message template that’s used for the campaign.
String treatmentDescription
The custom description of the default treatment for the campaign.
String treatmentName
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.
Integer version
The version number of the campaign.
Integer priority
Defines the priority of the campaign, used to decide the order of messages displayed to user if there are multiple messages scheduled to be displayed at the same moment.
String body
The body of the SMS message.
String messageType
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).
String originationNumber
The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
String senderId
The sender ID to display on recipients' devices when they receive the SMS message.
String entityId
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
String templateId
The template ID received from the regulatory body for sending SMS in your country.
String campaignStatus
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.
String applicationId
The unique identifier for the application.
String creationDate
The date and time, in ISO 8601 format, when the channel was enabled.
Boolean enabled
Specifies whether the channel is enabled for the application.
Boolean hasCredential
(Not used) This property is retained only for backward compatibility.
String id
(Deprecated) An identifier for the channel. This property is retained only for backward compatibility.
Boolean isArchived
Specifies whether the channel is archived.
String lastModifiedBy
The user who last modified the channel.
String lastModifiedDate
The date and time, in ISO 8601 format, when the channel was last modified.
Integer version
The current version of the channel.
List<E> conditions
The conditions to evaluate for the activity.
String operator
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.
Condition condition
The conditions that define the paths for the activity, and the relationship between the conditions.
WaitTime evaluationWaitTime
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.
String falseActivity
The unique identifier for the activity to perform if the conditions aren't met.
String trueActivity
The unique identifier for the activity to perform if the conditions are met.
String requestID
The unique identifier for the request or response.
String nextActivity
The unique identifier for the next activity to perform after the this activity.
String name
The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console.
Map<K,V> tags
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.
CreateApplicationRequest createApplicationRequest
ApplicationResponse applicationResponse
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
WriteCampaignRequest writeCampaignRequest
CampaignResponse campaignResponse
EmailTemplateRequest emailTemplateRequest
String templateName
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
CreateTemplateMessageBody createTemplateMessageBody
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
ExportJobRequest exportJobRequest
ExportJobResponse exportJobResponse
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
ImportJobRequest importJobRequest
ImportJobResponse importJobResponse
InAppTemplateRequest inAppTemplateRequest
String templateName
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
TemplateCreateMessageBody templateCreateMessageBody
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
WriteJourneyRequest writeJourneyRequest
JourneyResponse journeyResponse
PushNotificationTemplateRequest pushNotificationTemplateRequest
String templateName
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
CreateTemplateMessageBody createTemplateMessageBody
Map<K,V> attributes
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 description
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: _ ; () , ‐.
String name
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 (-).
String recommendationProviderIdType
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.
String recommendationProviderRoleArn
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.
String recommendationProviderUri
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.
String recommendationTransformerUri
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.
String recommendationsDisplayName
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.
Integer recommendationsPerMessage
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.
CreateRecommenderConfiguration createRecommenderConfiguration
RecommenderConfigurationResponse recommenderConfigurationResponse
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
WriteSegmentRequest writeSegmentRequest
SegmentResponse segmentResponse
SMSTemplateRequest sMSTemplateRequest
String templateName
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
CreateTemplateMessageBody createTemplateMessageBody
String templateName
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
VoiceTemplateRequest voiceTemplateRequest
CreateTemplateMessageBody createTemplateMessageBody
String deliveryUri
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.
List<E> endpointTypes
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 deliveryUri
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.
List<E> endpointTypes
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.
JourneyCustomMessage messageConfig
Specifies the message data included in a custom channel message that's sent to participants in a journey.
String nextActivity
The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.
String templateName
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.
String templateVersion
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 Versions resource.
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.
String backgroundColor
The background color of the button.
Integer borderRadius
The border radius of the button.
String buttonAction
Action triggered by the button.
String link
Button destination.
String text
Button text.
String textColor
The text color of the button.
String action
The default 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 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.
String body
The default body of the notification message.
Map<K,V> data
The JSON data payload to use for the default push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
Boolean silentPush
Specifies whether the default 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 or delivering messages to an in-app notification center.
Map<K,V> substitutions
The default message variables to use in the notification message. You can override the default variables with individual address variables.
String title
The default title to display above the notification message on a recipient's device.
String url
The default 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.
String action
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.
String body
The message body to use in push notifications that are based on the message template.
String sound
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.
String title
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.
String url
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.
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
ADMChannelResponse aDMChannelResponse
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
APNSChannelResponse aPNSChannelResponse
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
APNSSandboxChannelResponse aPNSSandboxChannelResponse
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
APNSVoipChannelResponse aPNSVoipChannelResponse
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
APNSVoipSandboxChannelResponse aPNSVoipSandboxChannelResponse
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
ApplicationResponse applicationResponse
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
BaiduChannelResponse baiduChannelResponse
CampaignResponse campaignResponse
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
EmailChannelResponse emailChannelResponse
String templateName
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
String version
The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.
If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.
If you don't specify a value for this parameter, Amazon Pinpoint does the following:
For a get operation, retrieves information about the active version of the template.
For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
For a delete operation, deletes the template, including all versions of the template.
MessageBody messageBody
EndpointResponse endpointResponse
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
EventStream eventStream
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
GCMChannelResponse gCMChannelResponse
String templateName
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
String version
The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.
If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.
If you don't specify a value for this parameter, Amazon Pinpoint does the following:
For a get operation, retrieves information about the active version of the template.
For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
For a delete operation, deletes the template, including all versions of the template.
MessageBody messageBody
JourneyResponse journeyResponse
String templateName
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
String version
The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.
If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.
If you don't specify a value for this parameter, Amazon Pinpoint does the following:
For a get operation, retrieves information about the active version of the template.
For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
For a delete operation, deletes the template, including all versions of the template.
MessageBody messageBody
String recommenderId
The unique identifier for the recommender model configuration. This identifier is displayed as the Recommender ID on the Amazon Pinpoint console.
RecommenderConfigurationResponse recommenderConfigurationResponse
SegmentResponse segmentResponse
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
SMSChannelResponse sMSChannelResponse
String templateName
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
String version
The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.
If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.
If you don't specify a value for this parameter, Amazon Pinpoint does the following:
For a get operation, retrieves information about the active version of the template.
For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
For a delete operation, deletes the template, including all versions of the template.
MessageBody messageBody
EndpointsResponse endpointsResponse
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
VoiceChannelResponse voiceChannelResponse
String templateName
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
String version
The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.
If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.
If you don't specify a value for this parameter, Amazon Pinpoint does the following:
For a get operation, retrieves information about the active version of the template.
For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
For a delete operation, deletes the template, including all versions of the template.
MessageBody messageBody
ADMMessage aDMMessage
The default push notification message for the ADM (Amazon Device Messaging) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).
APNSMessage aPNSMessage
The default push notification message for the APNs (Apple Push Notification service) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).
BaiduMessage baiduMessage
The default push notification message for the Baidu (Baidu Cloud Push) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).
DefaultMessage defaultMessage
The default message for all channels.
DefaultPushNotificationMessage defaultPushNotificationMessage
The default push notification message for all push notification channels.
EmailMessage emailMessage
The default message for the email channel. This message overrides the default message (DefaultMessage).
GCMMessage gCMMessage
The default push notification message for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default push notification message (DefaultPushNotificationMessage).
SMSMessage sMSMessage
The default message for the SMS channel. This message overrides the default message (DefaultMessage).
VoiceMessage voiceMessage
The default message for the voice channel. This message overrides the default message (DefaultMessage).
String configurationSet
The Amazon SES configuration set that you want to apply to messages that you send through the channel.
Boolean enabled
Specifies whether to enable the email channel for the application.
String fromAddress
The verified email address that you want to send email from when you send email through the channel.
String identity
The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that you want to use when you send email through the channel.
String roleArn
The ARN of the AWS Identity and Access Management (IAM) role that you want Amazon Pinpoint to use when it submits email-related event data for the channel.
String orchestrationSendingRoleArn
The ARN of an IAM role for Amazon Pinpoint to use to send email from your campaigns or journeys through Amazon SES.
String applicationId
The unique identifier for the application that the email channel applies to.
String configurationSet
The Amazon SES configuration set that's applied to messages that are sent through the channel.
String creationDate
The date and time, in ISO 8601 format, when the email channel was enabled.
Boolean enabled
Specifies whether the email channel is enabled for the application.
String fromAddress
The verified email address that email is sent from when you send email through the channel.
Boolean hasCredential
(Not used) This property is retained only for backward compatibility.
String id
(Deprecated) An identifier for the email channel. This property is retained only for backward compatibility.
String identity
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.
Boolean isArchived
Specifies whether the email channel is archived.
String lastModifiedBy
The user who last modified the email channel.
String lastModifiedDate
The date and time, in ISO 8601 format, when the email channel was last modified.
Integer messagesPerSecond
The maximum number of emails that can be sent through the channel each second.
String platform
The type of messaging or notification platform for the channel. For the email channel, this value is EMAIL.
String roleArn
The ARN of the AWS Identity and Access Management (IAM) role that Amazon Pinpoint uses to submit email-related event data for the channel.
String orchestrationSendingRoleArn
The ARN of an IAM role for Amazon Pinpoint to use to send email from your campaigns or journeys through Amazon SES.
Integer version
The current version of the email channel.
String body
The body of the email message.
String feedbackForwardingAddress
The email address to forward bounces and complaints to, if feedback forwarding is enabled.
String fromAddress
The verified email address to send the email message from. The default value is the FromAddress specified for the email channel.
RawEmail rawEmail
The email message, represented as a raw MIME message.
List<E> replyToAddresses
The reply-to email address(es) for the email message. If a recipient replies to the email, each reply-to address receives the reply.
SimpleEmail simpleEmail
The email message, composed of a subject, a text part, and an HTML part.
Map<K,V> substitutions
The default message variables to use in the email message. You can override the default variables with individual address variables.
JourneyEmailMessage messageConfig
Specifies the sender address for an email message that's sent to participants in the journey.
String nextActivity
The unique identifier for the next activity to perform, after the message is sent.
String templateName
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.
String templateVersion
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 Versions resource.
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.
String defaultSubstitutions
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.
String htmlPart
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.
String recommenderId
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.
String subject
The subject line, or title, to use in email messages that are based on the message template.
List<E> headers
The list of MessageHeaders for the email. You can have up to 15 Headers.
Map<K,V> tags
As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either Tags in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK.
(Deprecated) A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.
String templateDescription
A custom description of the message template.
String textPart
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.
String arn
The Amazon Resource Name (ARN) of the message template.
String creationDate
The date, in ISO 8601 format, when the message template was created.
String defaultSubstitutions
The JSON object that specifies the default values that are used 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.
String htmlPart
The message body, in HTML format, that's used in email messages that are based on the message template.
String lastModifiedDate
The date, in ISO 8601 format, when the message template was last modified.
String recommenderId
The unique identifier for the recommender model that's used by the message template.
String subject
The subject line, or title, that's used in email messages that are based on the message template.
List<E> headers
The list of MessageHeaders for the email. You can have up to 15 Headers.
Map<K,V> tags
A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.
String templateDescription
The custom description of the message template.
String templateName
The name of the message template.
String templateType
The type of channel that the message template is designed for. For an email template, this value is EMAIL.
String textPart
The message body, in plain text format, that's used in email messages that are based on the message template.
String version
The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.
String address
The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.
Map<K,V> attributes
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. 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 channelType
The channel to use when sending messages or push notifications to the endpoint.
EndpointDemographic demographic
The demographic information for the endpoint, such as the time zone and platform.
String effectiveDate
The date and time, in ISO 8601 format, when the endpoint was created or updated.
String endpointStatus
Specifies whether to send messages or push notifications to the endpoint. Valid 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.
String id
The unique identifier for the endpoint in the context of the batch.
EndpointLocation location
The geographic information for the endpoint.
Map<K,V> metrics
One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
String optOut
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.
String requestId
The unique identifier for the request to create or update the endpoint.
EndpointUser user
One or more custom attributes that describe the user who's associated with the endpoint.
String appVersion
The version of the app that's associated with the endpoint.
String locale
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.
String make
The manufacturer of the endpoint device, such as apple or samsung.
String model
The model name or number of the endpoint device, such as iPhone or SM-G900F.
String modelVersion
The model version of the endpoint device.
String platform
The platform of the endpoint device, such as ios.
String platformVersion
The platform version of the endpoint device.
String timezone
The time zone of the endpoint, specified as a tz database name value, such as America/Los_Angeles.
String city
The name of the city where the endpoint is located.
String country
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.
Double latitude
The latitude coordinate of the endpoint location, rounded to one decimal place.
Double longitude
The longitude coordinate of the endpoint location, rounded to one decimal place.
String postalCode
The postal or ZIP code for the area where the endpoint is located.
String region
The name of the region where the endpoint is located. For locations in the United States, this value is the name of a state.
String address
The endpoint address that the message was delivered to.
String deliveryStatus
The delivery status of the message. Possible values are:
DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.
OPT_OUT - The user who's associated with the endpoint has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.
PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint. Amazon Pinpoint won't attempt to send the message again.
SUCCESSFUL - The message was successfully delivered to the endpoint.
TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.
THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint.
UNKNOWN_FAILURE - An unknown error occurred.
String messageId
The unique identifier for the message that was sent.
Integer statusCode
The downstream service status code for delivering the message.
String statusMessage
The status message for delivering the message.
String updatedToken
For push notifications that are sent through the GCM channel, specifies whether the endpoint's device registration token was updated as part of delivering the message.
String address
The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.
Map<K,V> attributes
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. 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 channelType
The channel to use when sending messages or push notifications to the endpoint.
EndpointDemographic demographic
The demographic information for the endpoint, such as the time zone and platform.
String effectiveDate
The date and time, in ISO 8601 format, when the endpoint is updated.
String endpointStatus
Specifies whether to send messages or push notifications to the endpoint. Valid 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.
EndpointLocation location
The geographic information for the endpoint.
Map<K,V> metrics
One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
String optOut
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.
String requestId
The unique identifier for the most recent request to update the endpoint.
EndpointUser user
One or more custom attributes that describe the user who's associated with the endpoint.
String address
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.
String applicationId
The unique identifier for the application that's associated with the endpoint.
Map<K,V> attributes
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 channelType
The channel that's used when sending messages or push notifications to the endpoint.
String cohortId
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.
String creationDate
The date and time, in ISO 8601 format, when the endpoint was created.
EndpointDemographic demographic
The demographic information for the endpoint, such as the time zone and platform.
String effectiveDate
The date and time, in ISO 8601 format, when the endpoint was last updated.
String endpointStatus
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.
String id
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.
EndpointLocation location
The geographic information for the endpoint.
Map<K,V> metrics
One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
String optOut
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.
String requestId
The unique identifier for the most recent request to update the endpoint.
EndpointUser user
One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.
String bodyOverride
The body of the message. If specified, this value overrides the default message body.
Map<K,V> context
A map of custom attributes to attach to the message for the address. Attribute names are case sensitive.
For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.
String rawContent
The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides all other values for the message.
Map<K,V> substitutions
A map of the message variables to merge with the variables specified for the default message (DefaultMessage.Substitutions). The variables specified in this map take precedence over all other variables.
String titleOverride
The title or subject line of the message. If specified, this value overrides the default message title or subject line.
Map<K,V> userAttributes
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 userId
The unique identifier for the user.
String appPackageName
The package name of the app that's recording the event.
String appTitle
The title of the app that's recording the event.
String appVersionCode
The version number of the app that's recording the event.
Map<K,V> attributes
One or more custom attributes that are associated with the event.
String clientSdkVersion
The version of the SDK that's running on the client device.
String eventType
The name of the event.
Map<K,V> metrics
One or more custom metrics that are associated with the event.
String sdkName
The name of the SDK that's being used to record the event.
Session session
Information about the session in which the event occurred.
String timestamp
The date and time, in ISO 8601 format, when the event occurred.
EventDimensions dimensions
The dimensions for the event filter to use for the activity.
String messageActivity
The message identifier (message_id) for the message to use when determining whether message events meet the condition.
Map<K,V> attributes
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.
SetDimension eventType
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.
Map<K,V> metrics
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.
EventDimensions dimensions
The dimensions for the event filter to use for the campaign or the journey activity.
String filterType
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.
String message
A custom message that's returned in the response as a result of processing the event.
Integer statusCode
The status code that's returned in the response as a result of processing the event. Possible values are: 202, for events that were accepted; and, 400, for events that weren't valid.
PublicEndpoint endpoint
A set of properties and attributes that are associated with the endpoint.
Map<K,V> events
A set of properties that are associated with the event.
Map<K,V> results
A map that contains a multipart response for each endpoint. For each item in this object, the endpoint ID is the key and the item response is the value. If no item response exists, the value can also be one of the following: 202, the request was processed successfully; or 400, the payload wasn't valid or required fields were missing.
EventFilter eventFilter
String segmentId
String applicationId
The unique identifier for the application to publish event data for.
String destinationStreamArn
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:
For a Kinesis Data Firehose delivery stream, the ARN format is:
arn:aws:firehose:
String externalId
(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.
String lastModifiedDate
The date, in ISO 8601 format, when the event stream was last modified.
String lastUpdatedBy
The IAM user who last modified the event stream.
String roleArn
The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.
String roleArn
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.
String s3UrlPrefix
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://
String segmentId
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.
Integer segmentVersion
The version of the segment to export endpoint definitions from, if specified.
String roleArn
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.
String s3UrlPrefix
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://
String segmentId
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.
Integer segmentVersion
The version of the segment that the endpoint definitions were exported from.
String applicationId
The unique identifier for the application that's associated with the export job.
Integer completedPieces
The number of pieces that were processed successfully (completed) by the export job, as of the time of the request.
String completionDate
The date, in ISO 8601 format, when the export job was completed.
String creationDate
The date, in ISO 8601 format, when the export job was created.
ExportJobResource definition
The resource settings that apply to the export job.
Integer failedPieces
The number of pieces that weren't processed successfully (failed) by the export job, as of the time of the request.
List<E> failures
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
The unique identifier for the export job.
String jobStatus
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.
Integer totalFailures
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.
Integer totalPieces
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.
Integer totalProcessed
The total number of endpoint definitions that were processed by the export job.
String type
The job type. This value is EXPORT for export jobs.
List<E> item
An array of responses, one for each export job that's associated with the application (Export Jobs resource) or segment (Segment Export Jobs resource).
String nextToken
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
String requestID
The unique identifier for the request or response.
String apiKey
The Web API Key, also referred to as an API_KEY or server key, that you received from Google to communicate with Google services.
String defaultAuthenticationMethod
The default authentication method used for GCM. Values are either "TOKEN" or "KEY". Defaults to "KEY".
Boolean enabled
Specifies whether to enable the GCM channel for the application.
String serviceJson
The contents of the JSON file provided by Google during registration in order to generate an access token for authentication. For more information see Migrate from legacy FCM APIs to HTTP v1.
String applicationId
The unique identifier for the application that the GCM channel applies to.
String creationDate
The date and time when the GCM channel was enabled.
String credential
The Web API Key, also referred to as an API_KEY or server key, that you received from Google to communicate with Google services.
String defaultAuthenticationMethod
The default authentication method used for GCM. Values are either "TOKEN" or "KEY". Defaults to "KEY".
Boolean enabled
Specifies whether the GCM channel is enabled for the application.
Boolean hasCredential
(Not used) This property is retained only for backward compatibility.
Boolean hasFcmServiceCredentials
Returns true if the JSON file provided by Google during registration process was used in the ServiceJson field of the request.
String id
(Deprecated) An identifier for the GCM channel. This property is retained only for backward compatibility.
Boolean isArchived
Specifies whether the GCM channel is archived.
String lastModifiedBy
The user who last modified the GCM channel.
String lastModifiedDate
The date and time when the GCM channel was last modified.
String platform
The type of messaging or notification platform for the channel. For the GCM channel, this value is GCM.
Integer version
The current version of the GCM channel.
String action
The action to occur if the 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 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.
String body
The body of the notification message.
String collapseKey
An arbitrary string that identifies a group of messages that can be collapsed to ensure that only the last message is sent when delivery can resume. This helps avoid sending too many instances of the same messages when the recipient's device comes online again or becomes active.
Amazon Pinpoint specifies this value in the Firebase Cloud Messaging (FCM) collapse_key parameter when it sends the notification message to FCM.
Map<K,V> data
The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
String iconReference
The icon image name of the asset saved in your app.
String imageIconUrl
The URL of the large icon image to display in the content view of the push notification.
String imageUrl
The URL of an image to display in the push notification.
String preferredAuthenticationMethod
The preferred authentication method, with valid values "KEY" or "TOKEN". If a value isn't provided then the DefaultAuthenticationMethod is used.
String priority
para>normal – The notification might be delayed. Delivery is optimized for battery usage on the recipient's device. Use this value unless immediate delivery is required.
/listitem>high – The notification is sent immediately and might wake a sleeping device.
Amazon Pinpoint specifies this value in the FCM priority parameter when it sends the notification message to FCM.
The equivalent values for Apple Push Notification service (APNs) are 5, for normal, and 10, for high. If you specify an APNs value for this property, Amazon Pinpoint accepts and converts the value to the corresponding FCM value.
String rawContent
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.
String restrictedPackageName
The package name of the application where registration tokens must match in order for the recipient to receive the message.
Boolean silentPush
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 or supporting phone home functionality.
String smallImageIconUrl
The URL of the small icon image to display in the status bar and the content view of the push notification.
String sound
The sound to play when the recipient receives the push notification. 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/.
Map<K,V> substitutions
The default message variables to use in the notification message. You can override the default variables with individual address variables.
Integer timeToLive
The amount of time, in seconds, that FCM should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If you don't specify this value, FCM defaults to the maximum value, which is 2,419,200 seconds (28 days).
Amazon Pinpoint specifies this value in the FCM time_to_live parameter when it sends the notification message to FCM.
String title
The title to display above the notification message on the recipient's device.
String url
The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
ADMChannelResponse aDMChannelResponse
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
APNSChannelResponse aPNSChannelResponse
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
APNSSandboxChannelResponse aPNSSandboxChannelResponse
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
APNSVoipChannelResponse aPNSVoipChannelResponse
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
APNSVoipSandboxChannelResponse aPNSVoipSandboxChannelResponse
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
Date endTime
The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.
String kpiName
The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.
String nextToken
The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.
String pageSize
The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
Date startTime
The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be fewer than 90 days from the current day.
ApplicationDateRangeKpiResponse applicationDateRangeKpiResponse
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
ApplicationSettingsResource applicationSettingsResource
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
ApplicationResponse applicationResponse
ApplicationsResponse applicationsResponse
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
BaiduChannelResponse baiduChannelResponse
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
String campaignId
The unique identifier for the campaign.
String pageSize
The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
String token
The NextToken string that specifies which page of results to return in a paginated response.
ActivitiesResponse activitiesResponse
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
String campaignId
The unique identifier for the campaign.
Date endTime
The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.
String kpiName
The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.
String nextToken
The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.
String pageSize
The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
Date startTime
The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be fewer than 90 days from the current day.
CampaignDateRangeKpiResponse campaignDateRangeKpiResponse
CampaignResponse campaignResponse
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
String pageSize
The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
String token
The NextToken string that specifies which page of results to return in a paginated response.
CampaignsResponse campaignsResponse
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
String campaignId
The unique identifier for the campaign.
String version
The unique version number (Version property) for the campaign version.
CampaignResponse campaignResponse
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
String campaignId
The unique identifier for the campaign.
String pageSize
The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
String token
The NextToken string that specifies which page of results to return in a paginated response.
CampaignsResponse campaignsResponse
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
ChannelsResponse channelsResponse
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
EmailChannelResponse emailChannelResponse
String templateName
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
String version
The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.
If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.
If you don't specify a value for this parameter, Amazon Pinpoint does the following:
For a get operation, retrieves information about the active version of the template.
For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
For a delete operation, deletes the template, including all versions of the template.
EmailTemplateResponse emailTemplateResponse
EndpointResponse endpointResponse
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
EventStream eventStream
ExportJobResponse exportJobResponse
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
String pageSize
The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
String token
The NextToken string that specifies which page of results to return in a paginated response.
ExportJobsResponse exportJobsResponse
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
GCMChannelResponse gCMChannelResponse
ImportJobResponse importJobResponse
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
String pageSize
The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
String token
The NextToken string that specifies which page of results to return in a paginated response.
ImportJobsResponse importJobsResponse
InAppMessagesResponse inAppMessagesResponse
String templateName
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
String version
The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.
If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.
If you don't specify a value for this parameter, Amazon Pinpoint does the following:
For a get operation, retrieves information about the active version of the template.
For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
For a delete operation, deletes the template, including all versions of the template.
InAppTemplateResponse inAppTemplateResponse
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
Date endTime
The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.
String journeyId
The unique identifier for the journey.
String kpiName
The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.
String nextToken
The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.
String pageSize
The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
Date startTime
The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be fewer than 90 days from the current day.
JourneyDateRangeKpiResponse journeyDateRangeKpiResponse
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
String journeyActivityId
The unique identifier for the journey activity.
String journeyId
The unique identifier for the journey.
String nextToken
The
string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.
String pageSize
The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
JourneyExecutionActivityMetricsResponse journeyExecutionActivityMetricsResponse
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
String journeyId
The unique identifier for the journey.
String nextToken
The
string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.
String pageSize
The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
JourneyExecutionMetricsResponse journeyExecutionMetricsResponse
JourneyResponse journeyResponse
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
String journeyActivityId
The unique identifier for the journey activity.
String journeyId
The unique identifier for the journey.
String nextToken
The
string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.
String pageSize
The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
String runId
The unique identifier for the journey run.
JourneyRunExecutionActivityMetricsResponse journeyRunExecutionActivityMetricsResponse
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
String journeyId
The unique identifier for the journey.
String nextToken
The
string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.
String pageSize
The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
String runId
The unique identifier for the journey run.
JourneyRunExecutionMetricsResponse journeyRunExecutionMetricsResponse
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
String journeyId
The unique identifier for the journey.
String pageSize
The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
String token
The NextToken string that specifies which page of results to return in a paginated response.
JourneyRunsResponse journeyRunsResponse
String templateName
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
String version
The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.
If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.
If you don't specify a value for this parameter, Amazon Pinpoint does the following:
For a get operation, retrieves information about the active version of the template.
For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
For a delete operation, deletes the template, including all versions of the template.
PushNotificationTemplateResponse pushNotificationTemplateResponse
String recommenderId
The unique identifier for the recommender model configuration. This identifier is displayed as the Recommender ID on the Amazon Pinpoint console.
RecommenderConfigurationResponse recommenderConfigurationResponse
ListRecommenderConfigurationsResponse listRecommenderConfigurationsResponse
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
String pageSize
The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
String segmentId
The unique identifier for the segment.
String token
The NextToken string that specifies which page of results to return in a paginated response.
ExportJobsResponse exportJobsResponse
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
String pageSize
The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
String segmentId
The unique identifier for the segment.
String token
The NextToken string that specifies which page of results to return in a paginated response.
ImportJobsResponse importJobsResponse
SegmentResponse segmentResponse
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
String pageSize
The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
String token
The NextToken string that specifies which page of results to return in a paginated response.
SegmentsResponse segmentsResponse
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
String segmentId
The unique identifier for the segment.
String version
The unique version number (Version property) for the campaign version.
SegmentResponse segmentResponse
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
String pageSize
The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
String segmentId
The unique identifier for the segment.
String token
The NextToken string that specifies which page of results to return in a paginated response.
SegmentsResponse segmentsResponse
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
SMSChannelResponse sMSChannelResponse
String templateName
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
String version
The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.
If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.
If you don't specify a value for this parameter, Amazon Pinpoint does the following:
For a get operation, retrieves information about the active version of the template.
For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
For a delete operation, deletes the template, including all versions of the template.
SMSTemplateResponse sMSTemplateResponse
EndpointsResponse endpointsResponse
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
VoiceChannelResponse voiceChannelResponse
String templateName
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
String version
The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.
If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.
If you don't specify a value for this parameter, Amazon Pinpoint does the following:
For a get operation, retrieves information about the active version of the template.
For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
For a delete operation, deletes the template, including all versions of the template.
VoiceTemplateResponse voiceTemplateResponse
GPSCoordinates coordinates
The GPS coordinates to measure distance from.
Double rangeInKilometers
The range, in kilometers, from the GPS coordinates.
String nextActivity
The unique identifier for the next activity to perform, after performing the holdout activity.
Integer percentage
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.
Boolean defineSegment
Specifies whether to create a segment that contains the endpoints, when the endpoint definitions are imported.
String externalId
(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.
String format
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.
Boolean registerEndpoints
Specifies whether to register the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.
String roleArn
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.
String s3Url
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://
String segmentId
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.
String segmentName
A custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.
Boolean defineSegment
Specifies whether the import job creates a segment that contains the endpoints, when the endpoint definitions are imported.
String externalId
(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.
String format
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.
Boolean registerEndpoints
Specifies whether the import job registers the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.
String roleArn
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.
String s3Url
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://
String segmentId
The identifier for the segment that the import job updates or adds endpoint definitions to, if the import job updates an existing segment.
String segmentName
The custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.
String applicationId
The unique identifier for the application that's associated with the import job.
Integer completedPieces
The number of pieces that were processed successfully (completed) by the import job, as of the time of the request.
String completionDate
The date, in ISO 8601 format, when the import job was completed.
String creationDate
The date, in ISO 8601 format, when the import job was created.
ImportJobResource definition
The resource settings that apply to the import job.
Integer failedPieces
The number of pieces that weren't processed successfully (failed) by the import job, as of the time of the request.
List<E> failures
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
The unique identifier for the import job.
String jobStatus
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.
Integer totalFailures
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.
Integer totalPieces
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.
Integer totalProcessed
The total number of endpoint definitions that were processed by the import job.
String type
The job type. This value is IMPORT for import jobs.
List<E> item
An array of responses, one for each import job that's associated with the application (Import Jobs resource) or segment (Segment Import Jobs resource).
String nextToken
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
String endDate
The scheduled time after which the in-app message should not be shown. Timestamp is in ISO 8601 format.
CampaignEventFilter eventFilter
The event filter the SDK has to use to show the in-app message in the application.
QuietTime quietTime
Time during which the in-app message should not be shown to the user.
OverrideButtonConfiguration android
Default button content.
DefaultButtonConfiguration defaultConfig
Default button content.
OverrideButtonConfiguration iOS
Default button content.
OverrideButtonConfiguration web
Default button content.
String campaignId
Campaign id of the corresponding campaign.
Integer dailyCap
Daily cap which controls the number of times any in-app messages can be shown to the endpoint during a day.
InAppMessage inAppMessage
In-app message content with all fields required for rendering an in-app message.
Integer priority
Priority of the in-app message.
InAppCampaignSchedule schedule
Schedule of the campaign.
Integer sessionCap
Session cap which controls the number of times an in-app message can be shown to the endpoint during an application session.
Integer totalCap
Total cap which controls the number of times an in-app message can be shown to the endpoint.
String treatmentId
Treatment id of the campaign.
String backgroundColor
The background color for the message.
InAppMessageBodyConfig bodyConfig
The configuration for the message body.
InAppMessageHeaderConfig headerConfig
The configuration for the message header.
String imageUrl
The image url for the background of message.
InAppMessageButton primaryBtn
The first button inside the message.
InAppMessageButton secondaryBtn
The second button inside message.
List<E> content
The content of the message, can include up to 5 modals. Each modal must contain a message, a header, and background color. ImageUrl and buttons are optional.
Map<K,V> customConfig
Custom config to be sent to client.
String layout
The layout of the message.
Map<K,V> tags
As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either Tags in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK.
(Deprecated) A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.
String templateDescription
The description of the template.
String arn
The resource arn of the template.
List<E> content
The content of the message, can include up to 5 modals. Each modal must contain a message, a header, and background color. ImageUrl and buttons are optional.
String creationDate
The creation date of the template.
Map<K,V> customConfig
Custom config to be sent to client.
String lastModifiedDate
The last modified date of the template.
String layout
The layout of the message.
Map<K,V> tags
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 templateDescription
The description of the template.
String templateName
The name of the template.
String templateType
The type of the template.
String version
The version id of the template.
String requestID
The unique identifier for the request or response.
EndpointItemResponse endpointItemResponse
The response that was received after the endpoint data was accepted.
Map<K,V> eventsItemResponse
A multipart response object that contains a key and a value for each event in the request. In each object, the event ID is the key and an EventItemResponse object is the value.
String data
The message content that's passed to an AWS Lambda function or to a web hook.
String applicationId
The unique identifier for the application that the metric applies to.
Date endTime
The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
String journeyId
The unique identifier for the journey that the metric applies to.
String kpiName
The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.
BaseKpiResult kpiResult
An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.
String nextToken
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Journey Engagement Metrics resource because the resource returns all results in a single page.
Date startTime
The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
String fromAddress
The verified email address to send the email message from. The default address is the FromAddress specified for the email channel for the application.
String activityType
The type of activity that the metric applies to. Possible values are:
CONDITIONAL_SPLIT – For a yes/no split activity, which is an activity that sends participants down one of two paths in a journey.
HOLDOUT – For a holdout activity, which is an activity that stops a journey for a specified percentage of participants.
MESSAGE – For an email activity, which is an activity that sends an email message to participants.
MULTI_CONDITIONAL_SPLIT – For a multivariate split activity, which is an activity that sends participants down one of as many as five paths in a journey.
RANDOM_SPLIT – For a random split activity, which is an activity that sends specified percentages of participants down one of as many as five paths in a journey.
WAIT – For a wait activity, which is an activity that waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.
String applicationId
The unique identifier for the application that the metric applies to.
String journeyActivityId
The unique identifier for the activity that the metric applies to.
String journeyId
The unique identifier for the journey that the metric applies to.
String lastEvaluatedTime
The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the execution status of the activity and updated the data for the metric.
Map<K,V> metrics
A JSON object that contains the results of the query. The results vary depending on the type of activity (ActivityType). For information about the structure and contents of the results, see the Amazon Pinpoint Developer Guide.
String applicationId
The unique identifier for the application that the metric applies to.
String journeyId
The unique identifier for the journey that the metric applies to.
String lastEvaluatedTime
The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the journey and updated the data for the metric.
Map<K,V> metrics
A JSON object that contains the results of the query. For information about the structure and contents of the results, see the Amazon Pinpoint Developer Guide.
Integer dailyCap
The maximum number of messages that the journey can send to a single participant during a 24-hour period. The maximum value is 100.
Integer endpointReentryCap
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.
Integer messagesPerSecond
The maximum number of messages that the journey can send each second.
String endpointReentryInterval
Minimum time that must pass before an endpoint can re-enter a given journey. The duration should use an ISO 8601 format, such as PT1H.
JourneyTimeframeCap timeframeCap
The number of messages that an endpoint can receive during the specified timeframe.
Integer totalCap
The maximum number of messages a journey can sent to a single endpoint. The maximum value is 100. If set to 0, this limit will not apply.
String timeToLive
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.
Map<K,V> activities
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 applicationId
The unique identifier for the application that the journey applies to.
String creationDate
The date, in ISO 8601 format, when the journey was created.
String id
The unique identifier for the journey.
String lastModifiedDate
The date, in ISO 8601 format, when the journey was last modified.
JourneyLimits limits
The messaging and entry limits for the journey.
Boolean localTime
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.
String name
The name of the journey.
QuietTime quietTime
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.
String refreshFrequency
The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.
JourneySchedule schedule
The schedule settings for the journey.
String startActivity
The unique identifier for the first activity in the journey.
StartCondition startCondition
The segment that defines which users are participants in the journey.
String state
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.
Map<K,V> tags
This object is not used or supported.
Boolean waitForQuietTime
Indicates whether endpoints in quiet hours should enter a wait activity until quiet hours have elapsed.
Boolean refreshOnSegmentUpdate
Indicates whether the journey participants should be refreshed when a segment is updated.
JourneyChannelSettings journeyChannelSettings
The channel-specific configurations for the journey.
Boolean sendingSchedule
Indicates if journey has Advance Quiet Time enabled. This flag should be set to true in order to allow using OpenHours and ClosedDays.
OpenHours openHours
The time when a journey can send messages. QuietTime should be configured first and SendingSchedule should be set to true.
ClosedDays closedDays
The time when a journey will not send messages. QuietTime should be configured first and SendingSchedule should be set to true.
List<E> timezoneEstimationMethods
An array of time zone estimation methods, if any, to use for determining an Endpoints time zone if the Endpoint does not have a value for the Demographic.Timezone attribute.
PHONE_NUMBER - A time zone is determined based on the Endpoint.Address and Endpoint.Location.Country.
POSTAL_CODE - A time zone is determined based on the Endpoint.Location.PostalCode and Endpoint.Location.Country.
POSTAL_CODE detection is only supported in the United States, United Kingdom, Australia, New Zealand, Canada, France, Italy, Spain, Germany and in regions where Amazon Pinpoint is available.
String activityType
The type of activity that the metric applies to. Possible values are:
CONDITIONAL_SPLIT – For a yes/no split activity, which is an activity that sends participants down one of two paths in a journey.
HOLDOUT – For a holdout activity, which is an activity that stops a journey for a specified percentage of participants.
MESSAGE – For an email activity, which is an activity that sends an email message to participants.
MULTI_CONDITIONAL_SPLIT – For a multivariate split activity, which is an activity that sends participants down one of as many as five paths in a journey.
RANDOM_SPLIT – For a random split activity, which is an activity that sends specified percentages of participants down one of as many as five paths in a journey.
WAIT – For a wait activity, which is an activity that waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.
String applicationId
The unique identifier for the application that the metric applies to.
String journeyActivityId
The unique identifier for the activity that the metric applies to.
String journeyId
The unique identifier for the journey that the metric applies to.
String lastEvaluatedTime
The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the execution status of the activity for this journey run and updated the data for the metric.
Map<K,V> metrics
A JSON object that contains the results of the query. For information about the structure and contents of the results, see see Standard Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer Guide.
String runId
The unique identifier for the journey run that the metric applies to.
String applicationId
The unique identifier for the application that the metric applies to.
String journeyId
The unique identifier for the journey that the metric applies to.
String lastEvaluatedTime
The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the journey run and updated the data for the metric.
Map<K,V> metrics
A JSON object that contains the results of the query. For information about the structure and contents of the results, see the Standard Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer Guide.
String runId
The unique identifier for the journey run that the metric applies to.
String creationTime
The time when the journey run was created or scheduled, in ISO 8601 format.
String lastUpdateTime
The last time the journey run was updated, in ISO 8601 format..
String runId
The unique identifier for the run.
String status
The current status of the journey run.
Date endTime
The scheduled time, in ISO 8601 format, when the journey ended or will end.
Date startTime
The scheduled time, in ISO 8601 format, when the journey began or will begin.
String timezone
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.
String messageType
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).
String originationNumber
The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
String senderId
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.
String entityId
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
String templateId
The template ID received from the regulatory body for sending SMS in your country.
String state
The status of the journey. Currently, Supported values are ACTIVE, PAUSED, and CANCELLED
If you cancel a journey, Amazon Pinpoint continues to perform activities that are currently in progress, until those activities are complete. Amazon Pinpoint also continues to collect and aggregate analytics data for those activities, until they are complete, and any activities that were complete when you cancelled the journey.
After you cancel a journey, you can't add, change, or remove any activities from the journey. In addition, Amazon Pinpoint stops evaluating the journey and doesn't perform any activities that haven't started.
When the journey is paused, Amazon Pinpoint continues to perform activities that are currently in progress, until those activities are complete. Endpoints will stop entering journeys when the journey is paused and will resume entering the journey after the journey is resumed. For wait activities, wait time is paused when the journey is paused. Currently, PAUSED only supports journeys with a segment refresh interval.
Integer cap
The maximum number of messages that all journeys can send to an endpoint during the specified timeframe. The maximum value is 100. If set to 0, this limit will not apply.
Integer days
The length of the timeframe in days. The maximum value is 30. If set to 0, this limit will not apply.
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
String pageSize
The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
String token
The NextToken string that specifies which page of results to return in a paginated response.
JourneysResponse journeysResponse
List<E> item
An array of responses, one for each recommender model configuration that's associated with your Amazon Pinpoint account.
String nextToken
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
String resourceArn
The Amazon Resource Name (ARN) of the resource.
TagsModel tagsModel
String nextToken
The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.
String pageSize
The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
String prefix
The substring to match in the names of the message templates to include in the results. If you specify this value, Amazon Pinpoint returns only those templates whose names begin with the value that you specify.
String templateType
The type of message template to include in the results. Valid values are: EMAIL, PUSH, SMS, and VOICE. To include all types of templates in the results, don't include this parameter in your request.
TemplatesResponse templatesResponse
String nextToken
The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.
String pageSize
The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
String templateName
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
String templateType
The type of channel that the message template is designed for. Valid values are: EMAIL, PUSH, SMS, and VOICE.
TemplateVersionsResponse templateVersionsResponse
String action
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.
String body
The body of the notification message. The maximum number of characters is 200.
String imageIconUrl
The URL of the image to display as the push-notification icon, such as the icon for the app.
String imageSmallIconUrl
The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
String imageUrl
The URL of an image to display in the push notification.
String jsonBody
The JSON payload to use for a silent push notification.
String mediaUrl
The URL of the image or video to display in the push notification.
String rawContent
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.
Boolean silentPush
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.
Integer timeToLive
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.
String title
The title to display above the notification message on a recipient's device.
String url
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.
Message aDMMessage
The message that the campaign sends through the ADM (Amazon Device Messaging) channel. If specified, this message overrides the default message.
Message aPNSMessage
The message that the campaign sends through the APNs (Apple Push Notification service) channel. If specified, this message overrides the default message.
Message baiduMessage
The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. If specified, this message overrides the default message.
CampaignCustomMessage customMessage
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.
Message defaultMessage
The default message that the campaign sends through all the channels that are configured for the campaign.
CampaignEmailMessage emailMessage
The message that the campaign sends through the email channel. If specified, this message overrides the default message.
Message gCMMessage
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.
CampaignSmsMessage sMSMessage
The message that the campaign sends through the SMS channel. If specified, this message overrides the default message.
CampaignInAppMessage inAppMessage
The in-app message configuration.
String name
The name of the message header. The header name can contain up to 126 characters.
String value
The value of the message header. The header value can contain up to 870 characters, including the length of any rendered attributes. For example if you add the {CreationDate} attribute, it renders as YYYY-MM-DDTHH:MM:SS.SSSZ and is 24 characters in length.
Map<K,V> addresses
A map of key-value pairs, where each key is an address and each value is an AddressConfiguration object. An address can be a push notification token, a phone number, or an email address. You can use an AddressConfiguration object to tailor the message for an address by specifying settings such as content overrides and message variables.
Map<K,V> context
A map of custom attributes to attach to the message. For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.
Map<K,V> endpoints
A map of key-value pairs, where each key is an endpoint ID and each value is an EndpointSendConfiguration object. You can use an EndpointSendConfiguration object to tailor the message for an endpoint by specifying settings such as content overrides and message variables.
DirectMessageConfiguration messageConfiguration
The settings and content for the default message and any default messages that you defined for specific channels.
TemplateConfiguration templateConfiguration
The message template to use for the message.
String traceId
The unique identifier for tracing the message. This identifier is visible to message recipients.
String applicationId
The unique identifier for the application that was used to send the message.
Map<K,V> endpointResult
A map that contains a multipart response for each address that the message was sent to. In the map, the endpoint ID is the key and the result is the value.
String requestId
The identifier for the original request that the message was delivered for.
Map<K,V> result
A map that contains a multipart response for each address (email address, phone number, or push notification token) that the message was sent to. In the map, the address is the key and the result is the value.
String deliveryStatus
The delivery status of the message. Possible values are:
DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.
OPT_OUT - The user who's associated with the endpoint address has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.
PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint address. Amazon Pinpoint won't attempt to send the message again.
SUCCESSFUL - The message was successfully delivered to the endpoint address.
TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.
THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint address.
UNKNOWN_FAILURE - An unknown error occurred.
String messageId
The unique identifier for the message that was sent.
Integer statusCode
The downstream service status code for delivering the message.
String statusMessage
The status message for delivering the message.
String updatedToken
For push notifications that are sent through the GCM channel, specifies whether the endpoint's device registration token was updated as part of delivering the message.
String requestID
The unique identifier for the request or response.
SimpleCondition condition
The condition to evaluate for the activity path.
String nextActivity
The unique identifier for the next activity to perform, after completing the activity for the path.
List<E> branches
The paths for the activity, including the conditions for entering each path and the activity to perform for each path.
String defaultActivity
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.
WaitTime evaluationWaitTime
The amount of time to wait or the date and time when Amazon Pinpoint determines whether the conditions are met.
String requestID
The unique identifier for the request or response.
String isoCountryCode
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the phone number was originally registered.
String phoneNumber
The phone number to retrieve information about. The phone number that you provide should include a valid numeric country code. Otherwise, the operation might result in an error.
String carrier
The carrier or service provider that the phone number is currently registered with. In some countries and regions, this value may be the carrier or service provider that the phone number was originally registered with.
String city
The name of the city where the phone number was originally registered.
String cleansedPhoneNumberE164
The cleansed phone number, in E.164 format, for the location where the phone number was originally registered.
String cleansedPhoneNumberNational
The cleansed phone number, in the format for the location where the phone number was originally registered.
String country
The name of the country or region where the phone number was originally registered.
String countryCodeIso2
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the phone number was originally registered.
String countryCodeNumeric
The numeric code for the country or region where the phone number was originally registered.
String county
The name of the county where the phone number was originally registered.
String originalCountryCodeIso2
The two-character code, in ISO 3166-1 alpha-2 format, that was sent in the request body.
String originalPhoneNumber
The phone number that was sent in the request body.
String phoneType
The description of the phone type. Valid values are: MOBILE, LANDLINE, VOIP, INVALID, PREPAID, and OTHER.
Integer phoneTypeCode
The phone type, represented by an integer. Valid values are: 0 (mobile), 1 (landline), 2 (VoIP), 3 (invalid), 4 (other), and 5 (prepaid).
String timezone
The time zone for the location where the phone number was originally registered.
String zipCode
The postal or ZIP code for the location where the phone number was originally registered.
Map<K,V> eMAIL
Specifies the schedule settings for the email channel.
Map<K,V> sMS
Specifies the schedule settings for the SMS channel.
Map<K,V> pUSH
Specifies the schedule settings for the push channel.
Map<K,V> vOICE
Specifies the schedule settings for the voice channel.
Map<K,V> cUSTOM
Specifies the schedule settings for the custom channel.
String requestID
The unique identifier for the request or response.
NumberValidateRequest numberValidateRequest
NumberValidateResponse numberValidateResponse
String address
The unique identifier for the recipient, such as a device token, email address, or mobile phone number.
Map<K,V> attributes
One or more custom attributes that describe the endpoint by associating a name with an array of values. You can use these attributes as filter criteria when you create segments.
String channelType
The channel that's used when sending messages or push notifications to the endpoint.
EndpointDemographic demographic
The demographic information for the endpoint, such as the time zone and platform.
String effectiveDate
The date and time, in ISO 8601 format, when the endpoint was last updated.
String endpointStatus
Specifies whether to send messages or push notifications to the endpoint. Valid 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.
EndpointLocation location
The geographic information for the endpoint.
Map<K,V> metrics
One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
String optOut
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.
String requestId
A unique identifier that's generated each time the endpoint is updated.
EndpointUser user
One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.
JourneyPushMessage messageConfig
Specifies the time to live (TTL) value for push notifications that are sent to participants in a journey.
String nextActivity
The unique identifier for the next activity to perform, after the message is sent.
String templateName
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.
String templateVersion
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 Versions resource.
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.
AndroidPushNotificationTemplate aDM
The message template to use for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
APNSPushNotificationTemplate aPNS
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).
AndroidPushNotificationTemplate baidu
The message template to use for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
DefaultPushNotificationTemplate defaultValue
The default message template to use for push notification channels.
String defaultSubstitutions
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.
AndroidPushNotificationTemplate gCM
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).
String recommenderId
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.
Map<K,V> tags
As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either Tags in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK.
(Deprecated) A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.
String templateDescription
A custom description of the message template.
AndroidPushNotificationTemplate aDM
The message template that's used for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
APNSPushNotificationTemplate aPNS
The message template that's used for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
String arn
The Amazon Resource Name (ARN) of the message template.
AndroidPushNotificationTemplate baidu
The message template that's used for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
String creationDate
The date, in ISO 8601 format, when the message template was created.
DefaultPushNotificationTemplate defaultValue
The default message template that's used for push notification channels.
String defaultSubstitutions
The JSON object that specifies the default values that are used 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.
AndroidPushNotificationTemplate gCM
The message template that's used 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).
String lastModifiedDate
The date, in ISO 8601 format, when the message template was last modified.
String recommenderId
The unique identifier for the recommender model that's used by the message template.
Map<K,V> tags
A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.
String templateDescription
The custom description of the message template.
String templateName
The name of the message template.
String templateType
The type of channel that the message template is designed for. For a push notification template, this value is PUSH.
String version
The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
EventsRequest eventsRequest
EventsResponse eventsResponse
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
WriteEventStream writeEventStream
EventStream eventStream
String end
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.
String start
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.
String nextActivity
The unique identifier for the next activity to perform, after completing the activity for the path.
Integer percentage
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.
ByteBuffer data
The email message, represented as a raw MIME message. The entire message must be base64 encoded.
String duration
The duration to use when determining whether an endpoint is active or inactive.
String recencyType
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.
Map<K,V> attributes
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 creationDate
The date, in extended ISO 8601 format, when the configuration was created for the recommender model.
String description
The custom description of the configuration for the recommender model.
String id
The unique identifier for the recommender model configuration.
String lastModifiedDate
The date, in extended ISO 8601 format, when the configuration for the recommender model was last modified.
String name
The custom name of the configuration for the recommender model.
String recommendationProviderIdType
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.
String recommendationProviderRoleArn
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.
String recommendationProviderUri
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.
String recommendationTransformerUri
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.
String recommendationsDisplayName
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.
Integer recommendationsPerMessage
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.
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
String attributeType
The type of attribute or attributes to remove. Valid values are:
endpoint-custom-attributes - Custom attributes that describe endpoints, such as the date when an associated user opted in or out of receiving communications from you through a specific type of channel.
endpoint-metric-attributes - Custom metrics that your app reports to Amazon Pinpoint for endpoints, such as the number of app sessions or the number of items left in a cart.
endpoint-user-attributes - Custom attributes that describe users, such as first name, last name, and age.
UpdateAttributesRequest updateAttributesRequest
AttributesResource attributesResource
List<E> groupedBys
An array of objects that defines the field and field values that were used to group data in a result set that contains multiple results. This value is null if the data in a result set isn’t grouped.
List<E> values
An array of objects that provides pre-aggregated values for a standard metric that applies to an application, campaign, or journey.
String key
The friendly name of the metric whose value is specified by the Value property.
String type
The data type of the value specified by the Value property.
String value
In a Values object, the value for the metric that the query retrieved data for. In a GroupedBys object, the value for the field that was used to group data in a result set that contains multiple results (Values objects).
String endTime
The scheduled time, in ISO 8601 format, when the campaign ended or will end.
CampaignEventFilter eventFilter
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
String frequency
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
Boolean isLocalTime
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 quietTime
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.
String startTime
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.
String timezone
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.
RecencyDimension recency
The dimension settings that are based on how recently an endpoint was active.
String segmentId
The unique identifier for the segment to associate with the activity.
SetDimension appVersion
The app version criteria for the segment.
SetDimension channel
The channel criteria for the segment.
SetDimension deviceType
The device type criteria for the segment.
SetDimension make
The device make criteria for the segment.
SetDimension model
The device model criteria for the segment.
SetDimension platform
The device platform criteria for the segment.
Map<K,V> attributes
One or more custom attributes to use as criteria for the segment.
SegmentBehaviors behavior
The behavior-based criteria, such as how recently users have used your app, for the segment.
SegmentDemographics demographic
The demographic-based criteria, such as device platform, for the segment.
SegmentLocation location
The location-based criteria, such as region or GPS coordinates, for the segment.
Map<K,V> metrics
One or more custom metrics to use as criteria for the segment.
Map<K,V> userAttributes
One or more custom user attributes to use as criteria for the segment.
List<E> dimensions
An array that defines the dimensions for the segment.
List<E> sourceSegments
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.
String sourceType
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.
String type
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.
List<E> groups
An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.
String include
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.
Map<K,V> channelCounts
The number of channel types in the endpoint definitions that were imported to create the segment.
String externalId
(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.
String format
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.
String roleArn
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.
String s3Url
The URL of the Amazon Simple Storage Service (Amazon S3) bucket that the endpoint definitions were imported from to create the segment.
Integer size
The number of endpoint definitions that were imported successfully to create the segment.
SetDimension country
The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
GPSPointDimension gPSPoint
The GPS location and range for the segment.
String applicationId
The unique identifier for the application that the segment is associated with.
String arn
The Amazon Resource Name (ARN) of the segment.
String creationDate
The date and time when the segment was created.
SegmentDimensions dimensions
The dimension settings for the segment.
String id
The unique identifier for the segment.
SegmentImportResource importDefinition
The settings for the import job that's associated with the segment.
String lastModifiedDate
The date and time when the segment was last modified.
String name
The name of the segment.
SegmentGroupList segmentGroups
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.
String segmentType
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 they don't change over time.
Map<K,V> tags
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.
Integer version
The version number of the segment.
List<E> item
An array of responses, one for each segment that's associated with the application (Segments resource) or each version of a segment that's associated with the application (Segment Versions resource).
String nextToken
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
MessageRequest messageRequest
MessageResponse messageResponse
String applicationId
The unique ID of your Amazon Pinpoint application.
SendOTPMessageRequestParameters sendOTPMessageRequestParameters
Integer allowedAttempts
The attempts allowed to validate an OTP.
String brandName
The brand name that will be substituted into the OTP message body. Should be owned by calling AWS account.
String channel
Channel type for the OTP message. Supported values: [SMS].
Integer codeLength
The number of characters in the generated OTP.
String destinationIdentity
The destination identity to send OTP to.
String entityId
A unique Entity ID received from DLT after entity registration is approved.
String language
The language to be used for the outgoing message body containing the OTP.
String originationIdentity
The origination identity used to send OTP from.
String referenceId
Developer-specified reference identifier. Required to match during OTP verification.
String templateId
A unique Template ID received from DLT after entity registration is approved.
Integer validityPeriod
The time in minutes before the OTP is no longer valid.
MessageResponse messageResponse
Map<K,V> context
A map of custom attribute-value pairs. For a push notification, Amazon Pinpoint adds these attributes to the data.pinpoint object in the body of the notification payload. Amazon Pinpoint also provides these attributes in the events that it generates for users-messages deliveries.
DirectMessageConfiguration messageConfiguration
The settings and content for the default message and any default messages that you defined for specific channels.
TemplateConfiguration templateConfiguration
The message template to use for the message.
String traceId
The unique identifier for tracing the message. This identifier is visible to message recipients.
Map<K,V> users
A map that associates user IDs with EndpointSendConfiguration objects. You can use an EndpointSendConfiguration object to tailor the message for a user by specifying settings such as content overrides and message variables.
String applicationId
The unique identifier for the application that was used to send the message.
String requestId
The unique identifier that was assigned to the message request.
Map<K,V> result
An object that indicates which endpoints the message was sent to, for each user. The object lists user IDs and, for each user ID, provides the endpoint IDs that the message was sent to. For each endpoint ID, it provides an EndpointMessageResult object.
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
SendUsersMessageRequest sendUsersMessageRequest
SendUsersMessageResponse sendUsersMessageResponse
String dimensionType
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.
List<E> values
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.
EventCondition eventCondition
The dimension settings for the event that's associated with the activity.
SegmentCondition segmentCondition
The segment that's associated with the activity.
SegmentDimensions segmentDimensions
The dimension settings for the segment that's associated with the activity.
SimpleEmailPart htmlPart
The body of the email message, in HTML format. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.
SimpleEmailPart subject
The subject line, or title, of the email.
SimpleEmailPart textPart
The body of the email message, in plain text format. 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.
List<E> headers
The list of MessageHeaders for the email. You can have up to 15 Headers.
Boolean enabled
Specifies whether to enable the SMS channel for the application.
String senderId
The identity that you want to display on recipients' devices when they receive messages from the SMS channel.
String shortCode
The registered short code that you want to use when you send messages through the SMS channel.
String applicationId
The unique identifier for the application that the SMS channel applies to.
String creationDate
The date and time, in ISO 8601 format, when the SMS channel was enabled.
Boolean enabled
Specifies whether the SMS channel is enabled for the application.
Boolean hasCredential
(Not used) This property is retained only for backward compatibility.
String id
(Deprecated) An identifier for the SMS channel. This property is retained only for backward compatibility.
Boolean isArchived
Specifies whether the SMS channel is archived.
String lastModifiedBy
The user who last modified the SMS channel.
String lastModifiedDate
The date and time, in ISO 8601 format, when the SMS channel was last modified.
String platform
The type of messaging or notification platform for the channel. For the SMS channel, this value is SMS.
Integer promotionalMessagesPerSecond
The maximum number of promotional messages that you can send through the SMS channel each second.
String senderId
The identity that displays on recipients' devices when they receive messages from the SMS channel.
String shortCode
The registered short code to use when you send messages through the SMS channel.
Integer transactionalMessagesPerSecond
The maximum number of transactional messages that you can send through the SMS channel each second.
Integer version
The current version of the SMS channel.
String body
The body of the SMS message.
String keyword
The SMS program name that you provided to AWS Support when you requested your dedicated number.
String mediaUrl
This field is reserved for future use.
String messageType
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).
String originationNumber
The number to send the SMS message from. This value should be one of the dedicated long or short codes that's assigned to your AWS account. If you don't specify a long or short code, Amazon Pinpoint assigns a random long code to the SMS message and sends the message from that code.
String senderId
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.
Map<K,V> substitutions
The message variables to use in the SMS message. You can override the default variables with individual address variables.
String entityId
The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
String templateId
The template ID received from the regulatory body for sending SMS in your country.
JourneySMSMessage messageConfig
Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.
String nextActivity
The unique identifier for the next activity to perform, after the message is sent.
String templateName
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.
String templateVersion
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 Versions resource.
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.
String body
The message body to use in text messages that are based on the message template.
String defaultSubstitutions
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.
String recommenderId
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.
Map<K,V> tags
As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either Tags in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK.
(Deprecated) A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.
String templateDescription
A custom description of the message template.
String arn
The Amazon Resource Name (ARN) of the message template.
String body
The message body that's used in text messages that are based on the message template.
String creationDate
The date, in ISO 8601 format, when the message template was created.
String defaultSubstitutions
The JSON object that specifies the default values that are used 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.
String lastModifiedDate
The date, in ISO 8601 format, when the message template was last modified.
String recommenderId
The unique identifier for the recommender model that's used by the message template.
Map<K,V> tags
A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.
String templateDescription
The custom description of the message template.
String templateName
The name of the message template.
String templateType
The type of channel that the message template is designed for. For an SMS template, this value is SMS.
String version
The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.
String description
The custom description of the condition.
EventStartCondition eventStartCondition
SegmentCondition segmentStartCondition
The segment that's associated with the first activity in the journey. This segment determines which users are participants in the journey.
Map<K,V> tags
A string-to-string map of key-value pairs that defines the tags for an application, campaign, message template, or segment. Each of these resources can have a maximum of 50 tags.
Each tag consists of a required tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.
String name
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
String version
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 Versions resource.
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.
String version
The version of the message template to use as the active version of the template. Valid values are: latest, for the most recent version of the template; or, the unique identifier for any existing version of the template. If you specify an identifier, the 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 Versions resource.
Template emailTemplate
The email template to use for the message.
Template pushTemplate
The push notification template to use for the message.
Template sMSTemplate
The SMS template to use for the message.
Template voiceTemplate
The voice template to use for the message. This object isn't supported for campaigns.
Template inAppTemplate
The InApp template to use for the message. The InApp template object is not supported for SendMessages.
String arn
The Amazon Resource Name (ARN) of the message template. This value isn't included in a TemplateResponse object. To retrieve the ARN of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the ARN for.
String creationDate
The date, in ISO 8601 format, when the message template was created.
String defaultSubstitutions
The JSON object that specifies the default values that are used for message variables in the message template. This object isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.
String lastModifiedDate
The date, in ISO 8601 format, when the message template was last modified.
Map<K,V> tags
A map of key-value pairs that identifies the tags that are associated with the message template. This object isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.
String templateDescription
The custom description of the message template. This value isn't included in a TemplateResponse object. To retrieve the description of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the description for.
String templateName
The name of the message template.
String templateType
The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, INAPP, and VOICE.
String version
The unique identifier, as an integer, for the active version of the message template.
List<E> item
An array of responses, one for each message template that's associated with your Amazon Pinpoint account and meets any filter criteria that you specified in the request.
String nextToken
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
String creationDate
The date, in ISO 8601 format, when the version of the message template was created.
String defaultSubstitutions
A JSON object that specifies the default values that are used for message variables in the version of 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.
String lastModifiedDate
The date, in ISO 8601 format, when the version of the message template was last modified.
String templateDescription
The custom description of the version of the message template.
String templateName
The name of the message template.
String templateType
The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, INAPP, and VOICE.
String version
The unique identifier for the version of the message template. This value is an integer that Amazon Pinpoint automatically increments and assigns to each new version of a template.
List<E> item
An array of responses, one for each version of the message template.
String message
The message that's returned from the API for the request to retrieve information about all the versions of the message template.
String nextToken
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
String requestID
The unique identifier for the request to retrieve information about all the versions of the message template.
String requestID
The unique identifier for the request or response.
CustomDeliveryConfiguration customDeliveryConfiguration
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.
String id
The unique identifier for the treatment.
MessageConfiguration messageConfiguration
The message configuration settings for the treatment.
Schedule schedule
The schedule settings for the treatment.
Integer sizePercent
The allocated percentage of users (segment members) that the treatment is sent to.
CampaignState state
The current status of the treatment.
TemplateConfiguration templateConfiguration
The message template to use for the treatment.
String treatmentDescription
The custom description of the treatment.
String treatmentName
The custom name of the treatment.
ADMChannelRequest aDMChannelRequest
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
ADMChannelResponse aDMChannelResponse
APNSChannelRequest aPNSChannelRequest
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
APNSChannelResponse aPNSChannelResponse
APNSSandboxChannelRequest aPNSSandboxChannelRequest
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
APNSSandboxChannelResponse aPNSSandboxChannelResponse
APNSVoipChannelRequest aPNSVoipChannelRequest
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
APNSVoipChannelResponse aPNSVoipChannelResponse
APNSVoipSandboxChannelRequest aPNSVoipSandboxChannelRequest
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
APNSVoipSandboxChannelResponse aPNSVoipSandboxChannelResponse
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
WriteApplicationSettingsRequest writeApplicationSettingsRequest
ApplicationSettingsResource applicationSettingsResource
List<E> blacklist
An array of the attributes to remove from all the endpoints that are associated with the application. The array can specify the complete, exact name of each attribute to remove or it can specify a glob pattern that an attribute name must match in order for the attribute to be removed.
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
BaiduChannelRequest baiduChannelRequest
BaiduChannelResponse baiduChannelResponse
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
String campaignId
The unique identifier for the campaign.
WriteCampaignRequest writeCampaignRequest
CampaignResponse campaignResponse
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
EmailChannelRequest emailChannelRequest
EmailChannelResponse emailChannelResponse
Boolean createNewVersion
Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.
If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.
EmailTemplateRequest emailTemplateRequest
String templateName
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
String version
The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.
If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.
If you don't specify a value for this parameter, Amazon Pinpoint does the following:
For a get operation, retrieves information about the active version of the template.
For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
For a delete operation, deletes the template, including all versions of the template.
MessageBody messageBody
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
String endpointId
The case insensitive unique identifier for the endpoint. The identifier can't contain $,
{ or }.
EndpointRequest endpointRequest
MessageBody messageBody
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
EndpointBatchRequest endpointBatchRequest
MessageBody messageBody
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
GCMChannelRequest gCMChannelRequest
GCMChannelResponse gCMChannelResponse
Boolean createNewVersion
Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.
If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.
InAppTemplateRequest inAppTemplateRequest
String templateName
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
String version
The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.
If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.
If you don't specify a value for this parameter, Amazon Pinpoint does the following:
For a get operation, retrieves information about the active version of the template.
For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
For a delete operation, deletes the template, including all versions of the template.
MessageBody messageBody
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
String journeyId
The unique identifier for the journey.
WriteJourneyRequest writeJourneyRequest
JourneyResponse journeyResponse
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
String journeyId
The unique identifier for the journey.
JourneyStateRequest journeyStateRequest
JourneyResponse journeyResponse
Boolean createNewVersion
Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.
If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.
PushNotificationTemplateRequest pushNotificationTemplateRequest
String templateName
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
String version
The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.
If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.
If you don't specify a value for this parameter, Amazon Pinpoint does the following:
For a get operation, retrieves information about the active version of the template.
For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
For a delete operation, deletes the template, including all versions of the template.
MessageBody messageBody
Map<K,V> attributes
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 description
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: _ ; () , ‐.
String name
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 (-).
String recommendationProviderIdType
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.
String recommendationProviderRoleArn
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.
String recommendationProviderUri
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.
String recommendationTransformerUri
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.
String recommendationsDisplayName
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.
Integer recommendationsPerMessage
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.
String recommenderId
The unique identifier for the recommender model configuration. This identifier is displayed as the Recommender ID on the Amazon Pinpoint console.
UpdateRecommenderConfiguration updateRecommenderConfiguration
RecommenderConfigurationResponse recommenderConfigurationResponse
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
String segmentId
The unique identifier for the segment.
WriteSegmentRequest writeSegmentRequest
SegmentResponse segmentResponse
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
SMSChannelRequest sMSChannelRequest
SMSChannelResponse sMSChannelResponse
Boolean createNewVersion
Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.
If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.
SMSTemplateRequest sMSTemplateRequest
String templateName
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
String version
The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.
If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.
If you don't specify a value for this parameter, Amazon Pinpoint does the following:
For a get operation, retrieves information about the active version of the template.
For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
For a delete operation, deletes the template, including all versions of the template.
MessageBody messageBody
TemplateActiveVersionRequest templateActiveVersionRequest
String templateName
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
String templateType
The type of channel that the message template is designed for. Valid values are: EMAIL, PUSH, SMS, and VOICE.
MessageBody messageBody
String applicationId
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
VoiceChannelRequest voiceChannelRequest
VoiceChannelResponse voiceChannelResponse
Boolean createNewVersion
Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.
If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.
String templateName
The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
String version
The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.
If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.
If you don't specify a value for this parameter, Amazon Pinpoint does the following:
For a get operation, retrieves information about the active version of the template.
For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.
For a delete operation, deletes the template, including all versions of the template.
VoiceTemplateRequest voiceTemplateRequest
MessageBody messageBody
Boolean valid
Specifies whether the OTP is valid or not.
String applicationId
The unique ID of your Amazon Pinpoint application.
VerifyOTPMessageRequestParameters verifyOTPMessageRequestParameters
VerificationResponse verificationResponse
Boolean enabled
Specifies whether to enable the voice channel for the application.
String applicationId
The unique identifier for the application that the voice channel applies to.
String creationDate
The date and time, in ISO 8601 format, when the voice channel was enabled.
Boolean enabled
Specifies whether the voice channel is enabled for the application.
Boolean hasCredential
(Not used) This property is retained only for backward compatibility.
String id
(Deprecated) An identifier for the voice channel. This property is retained only for backward compatibility.
Boolean isArchived
Specifies whether the voice channel is archived.
String lastModifiedBy
The user who last modified the voice channel.
String lastModifiedDate
The date and time, in ISO 8601 format, when the voice channel was last modified.
String platform
The type of messaging or notification platform for the channel. For the voice channel, this value is VOICE.
Integer version
The current version of the voice channel.
String body
The text of the script to use for the voice message.
String languageCode
The code for the language to use when synthesizing the text of the message script. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide.
String originationNumber
The long code to send the voice message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code in E.164 format, for example +12065550100, to ensure prompt and accurate delivery of the message.
Map<K,V> substitutions
The default message variables to use in the voice message. You can override the default variables with individual address variables.
String voiceId
The name of the voice to use when delivering the message. For a list of supported voices, see the Amazon Polly Developer Guide.
String body
The text of the script to use in messages that are based on the message template, in plain text format.
String defaultSubstitutions
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.
String languageCode
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.
Map<K,V> tags
As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either Tags in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK.
(Deprecated) A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.
String templateDescription
A custom description of the message template.
String voiceId
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.
String arn
The Amazon Resource Name (ARN) of the message template.
String body
The text of the script that's used in messages that are based on the message template, in plain text format.
String creationDate
The date, in ISO 8601 format, when the message template was created.
String defaultSubstitutions
The JSON object that specifies the default values that are used 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.
String languageCode
The code for the language that's used 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.
String lastModifiedDate
The date, in ISO 8601 format, when the message template was last modified.
Map<K,V> tags
A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.
String templateDescription
The custom description of the message template.
String templateName
The name of the message template.
String templateType
The type of channel that the message template is designed for. For a voice template, this value is VOICE.
String version
The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.
String voiceId
The name of the voice that's used when delivering messages that are based on the message template. For a list of supported voices, see the Amazon Polly Developer Guide.
String waitFor
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.
String waitUntil
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.
CampaignHook campaignHook
The settings for the AWS Lambda function to invoke by default as a code hook for campaigns in the application. You can use this hook to customize segments that are used by campaigns in the application.
To override these settings and define custom settings for a specific campaign, use the CampaignHook object of the Campaign resource.
Boolean cloudWatchMetricsEnabled
Specifies whether to enable application-related alarms in Amazon CloudWatch.
Boolean eventTaggingEnabled
CampaignLimits limits
The default sending limits for campaigns in the application. To override these limits and define custom limits for a specific campaign or journey, use the Campaign resource or the Journey resource, respectively.
QuietTime quietTime
The default quiet time for campaigns in the application. Quiet time is a specific time range when messages aren't sent 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 application (or a campaign or journey that has custom quiet time settings).
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 application (or a campaign or journey that has custom quiet time settings).
If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled.
To override the default quiet time settings for a specific campaign or journey, use the Campaign resource or the Journey resource to define a custom quiet time for the campaign or journey.
ApplicationSettingsJourneyLimits journeyLimits
The default sending limits for journeys in the application. These limits apply to each journey for the application but can be overridden, on a per journey basis, with the JourneyLimits resource.
List<E> additionalTreatments
An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
CustomDeliveryConfiguration customDeliveryConfiguration
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.
String description
A custom description of the campaign.
Integer holdoutPercent
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
CampaignHook hook
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.
Boolean isPaused
Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing this value to false.
CampaignLimits limits
The messaging limits for the campaign.
MessageConfiguration messageConfiguration
The message configuration settings for the campaign.
String name
A custom name for the campaign.
Schedule schedule
The schedule settings for the campaign.
String segmentId
The unique identifier for the segment to associate with the campaign.
Integer segmentVersion
The version of the segment to associate with the campaign.
Map<K,V> tags
As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either Tags in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK.
(Deprecated) A string-to-string map of key-value pairs that defines the tags to associate with the campaign. Each tag consists of a required tag key and an associated tag value.
TemplateConfiguration templateConfiguration
The message template to use for the campaign.
String treatmentDescription
A custom description of the default treatment for the campaign.
String treatmentName
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.
Integer priority
Defines the priority of the campaign, used to decide the order of messages displayed to user if there are multiple messages scheduled to be displayed at the same moment.
String destinationStreamArn
The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream that you want to publish event data to.
For a Kinesis data stream, the ARN format is:
arn:aws:kinesis:
For a Kinesis Data Firehose delivery stream, the ARN format is:
arn:aws:firehose:
String roleArn
The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.
Map<K,V> activities
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 creationDate
The date, in ISO 8601 format, when the journey was created.
String lastModifiedDate
The date, in ISO 8601 format, when the journey was last modified.
JourneyLimits limits
The messaging and entry limits for the journey.
Boolean localTime
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.
String name
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 quietTime
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.
String refreshFrequency
The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.
JourneySchedule schedule
The schedule settings for the journey.
String startActivity
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 startCondition
The segment that defines which users are participants in the journey.
String state
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.
PAUSED, CANCELLED, COMPLETED, and CLOSED states are not supported in requests to create or update a journey. To cancel, pause, or resume a journey, use the Journey State resource.
Boolean waitForQuietTime
Specifies whether endpoints in quiet hours should enter a wait till the end of their quiet hours.
Boolean refreshOnSegmentUpdate
Indicates whether the journey participants should be refreshed when a segment is updated.
JourneyChannelSettings journeyChannelSettings
The channel-specific configurations for the journey.
Boolean sendingSchedule
Indicates if journey has Advance Quiet Time enabled. This flag should be set to true in order to allow using OpenHours and ClosedDays.
OpenHours openHours
The time when journey allow to send messages. QuietTime should be configured first and SendingSchedule should be set to true.
ClosedDays closedDays
The time when journey will stop sending messages. QuietTime should be configured first and SendingSchedule should be set to true.
List<E> timezoneEstimationMethods
An array of time zone estimation methods, if any, to use for determining an Endpoints time zone if the Endpoint does not have a value for the Demographic.Timezone attribute.
PHONE_NUMBER - A time zone is determined based on the Endpoint.Address and Endpoint.Location.Country.
POSTAL_CODE - A time zone is determined based on the Endpoint.Location.PostalCode and Endpoint.Location.Country.
POSTAL_CODE detection is only supported in the United States, United Kingdom, Australia, New Zealand, Canada, France, Italy, Spain, Germany and in regions where Amazon Pinpoint is available.
SegmentDimensions dimensions
The criteria that define the dimensions for the segment.
String name
The name of the segment.
SegmentGroupList segmentGroups
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.
Map<K,V> tags
As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either Tags in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK.
(Deprecated) A string-to-string map of key-value pairs that defines the tags to associate with the segment. Each tag consists of a required tag key and an associated tag value.
CustomDeliveryConfiguration customDeliveryConfiguration
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.
MessageConfiguration messageConfiguration
The message configuration settings for the treatment.
Schedule schedule
The schedule settings for the treatment.
Integer sizePercent
The allocated percentage of users (segment members) to send the treatment to.
TemplateConfiguration templateConfiguration
The message template to use for the treatment.
String treatmentDescription
A custom description of the treatment.
String treatmentName
A custom name for the treatment.
Copyright © 2024. All rights reserved.