// Code generated by smithy-go-codegen DO NOT EDIT.

package types

import (
	smithydocument "github.com/aws/smithy-go/document"
	"time"
)

// Provides information about the activities that were performed by a campaign.
type ActivitiesResponse struct {

	// An array of responses, one for each activity that was performed by the campaign.
	//
	// This member is required.
	Item []ActivityResponse

	// 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.
	NextToken *string

	noSmithyDocumentSerde
}

// Specifies the configuration and other settings for an activity in a journey.
type Activity struct {

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

	// 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.
	ConditionalSplit *ConditionalSplitActivity

	// The settings for a connect activity. This type of activity initiates a contact
	// center call to participants.
	ContactCenter *ContactCenterActivity

	// The custom description of the activity.
	Description *string

	// The settings for an email activity. This type of activity sends an email
	// message to participants.
	EMAIL *EmailMessageActivity

	// The settings for a holdout activity. This type of activity stops a journey for
	// a specified percentage of participants.
	Holdout *HoldoutActivity

	// 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.
	MultiCondition *MultiConditionalSplitActivity

	// The settings for a push notification activity. This type of activity sends a
	// push notification to participants.
	PUSH *PushMessageActivity

	// 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.
	RandomSplit *RandomSplitActivity

	// The settings for an SMS activity. This type of activity sends a text message to
	// participants.
	SMS *SMSMessageActivity

	// 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.
	Wait *WaitActivity

	noSmithyDocumentSerde
}

// Provides information about an activity that was performed by a campaign.
type ActivityResponse struct {

	// The unique identifier for the application that the campaign applies to.
	//
	// This member is required.
	ApplicationId *string

	// The unique identifier for the campaign that the activity applies to.
	//
	// This member is required.
	CampaignId *string

	// The unique identifier for the activity.
	//
	// This member is required.
	Id *string

	// The actual time, in ISO 8601 format, when the activity was marked CANCELLED or
	// COMPLETED.
	End *string

	// 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 (https://docs.aws.amazon.com//pinpoint/latest/developerguide/analytics-standard-metrics.html)
	// in the Amazon Pinpoint Developer Guide.
	ExecutionMetrics map[string]string

	// Specifies whether the activity succeeded. Possible values are SUCCESS and FAIL.
	Result *string

	// The scheduled start time, in ISO 8601 format, for the activity.
	ScheduledStart *string

	// The actual start time, in ISO 8601 format, of the activity.
	Start *string

	// The current status of the activity. Possible values are: PENDING, INITIALIZING,
	// RUNNING, PAUSED, CANCELLED, and COMPLETED.
	State *string

	// The total number of endpoints that the campaign successfully delivered messages
	// to.
	SuccessfulEndpointCount int32

	// The total number of time zones that were completed.
	TimezonesCompletedCount int32

	// The total number of unique time zones that are in the segment for the campaign.
	TimezonesTotalCount int32

	// The total number of endpoints that the campaign attempted to deliver messages
	// to.
	TotalEndpointCount int32

	// 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.
	TreatmentId *string

	noSmithyDocumentSerde
}

// Specifies address-based configuration settings for a message that's sent
// directly to an endpoint.
type AddressConfiguration struct {

	// The message body to use instead of the default message body. This value
	// overrides the default message body.
	BodyOverride *string

	// The channel to use when sending the message.
	ChannelType ChannelType

	// 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.
	Context map[string]string

	// The raw, JSON-formatted string to use as the payload for the message. If
	// specified, this value overrides all other values for the message.
	RawContent *string

	// 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.
	Substitutions map[string][]string

	// The message title to use instead of the default message title. This value
	// overrides the default message title.
	TitleOverride *string

	noSmithyDocumentSerde
}

// Specifies the status and settings of the ADM (Amazon Device Messaging) channel
// for an application.
type ADMChannelRequest struct {

	// The Client ID that you received from Amazon to send messages by using ADM.
	//
	// This member is required.
	ClientId *string

	// The Client Secret that you received from Amazon to send messages by using ADM.
	//
	// This member is required.
	ClientSecret *string

	// Specifies whether to enable the ADM channel for the application.
	Enabled bool

	noSmithyDocumentSerde
}

// Provides information about the status and settings of the ADM (Amazon Device
// Messaging) channel for an application.
type ADMChannelResponse struct {

	// The type of messaging or notification platform for the channel. For the ADM
	// channel, this value is ADM.
	//
	// This member is required.
	Platform *string

	// The unique identifier for the application that the ADM channel applies to.
	ApplicationId *string

	// The date and time when the ADM channel was enabled.
	CreationDate *string

	// Specifies whether the ADM channel is enabled for the application.
	Enabled bool

	// (Not used) This property is retained only for backward compatibility.
	HasCredential bool

	// (Deprecated) An identifier for the ADM channel. This property is retained only
	// for backward compatibility.
	Id *string

	// Specifies whether the ADM channel is archived.
	IsArchived bool

	// The user who last modified the ADM channel.
	LastModifiedBy *string

	// The date and time when the ADM channel was last modified.
	LastModifiedDate *string

	// The current version of the ADM channel.
	Version int32

	noSmithyDocumentSerde
}

// Specifies the settings for a one-time message that's sent directly to an
// endpoint through the ADM (Amazon Device Messaging) channel.
type ADMMessage struct {

	// 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.
	Action Action

	// The body of the notification message.
	Body *string

	// 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.
	ConsolidationKey *string

	// 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.
	Data map[string]string

	// 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.
	ExpiresAfter *string

	// The icon image name of the asset saved in your app.
	IconReference *string

	// The URL of the large icon image to display in the content view of the push
	// notification.
	ImageIconUrl *string

	// The URL of an image to display in the push notification.
	ImageUrl *string

	// 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.
	MD5 *string

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

	// 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.
	SilentPush bool

	// The URL of the small icon image to display in the status bar and the content
	// view of the push notification.
	SmallImageIconUrl *string

	// 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/.
	Sound *string

	// The default message variables to use in the notification message. You can
	// override the default variables with individual address variables.
	Substitutions map[string][]string

	// The title to display above the notification message on the recipient's device.
	Title *string

	// 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.
	Url *string

	noSmithyDocumentSerde
}

// Specifies channel-specific content and settings for a message template that can
// be used in push notifications that are sent through the ADM (Amazon Device
// Messaging), Baidu (Baidu Cloud Push), or GCM (Firebase Cloud Messaging, formerly
// Google Cloud Messaging) channel.
type AndroidPushNotificationTemplate struct {

	// 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.
	Action Action

	// The message body to use in a push notification that's based on the message
	// template.
	Body *string

	// The URL of the large icon image to display in the content view of a push
	// notification that's based on the message template.
	ImageIconUrl *string

	// The URL of an image to display in a push notification that's based on the
	// message template.
	ImageUrl *string

	// The raw, JSON-formatted string to use as the payload for a push notification
	// that's based on the message template. If specified, this value overrides all
	// other content for the message template.
	RawContent *string

	// The URL of the small icon image to display in the status bar and the content
	// view of a push notification that's based on the message template.
	SmallImageIconUrl *string

	// The sound to play when a recipient receives a push notification that's based on
	// the message template. You can use the default stream or specify the file name of
	// a sound resource that's bundled in your app. On an Android platform, the sound
	// file must reside in /res/raw/.
	Sound *string

	// The title to use in a push notification that's based on the message template.
	// This title appears above the notification message on a recipient's device.
	Title *string

	// The URL to open in a recipient's default mobile browser, if a recipient taps a
	// push notification that's based on the message template and the value of the
	// Action property is URL.
	Url *string

	noSmithyDocumentSerde
}

// Specifies the status and settings of the APNs (Apple Push Notification service)
// channel for an application.
type APNSChannelRequest struct {

	// The bundle identifier that's assigned to your iOS app. This identifier is used
	// for APNs tokens.
	BundleId *string

	// The APNs client certificate that you received from Apple, if you want Amazon
	// Pinpoint to communicate with APNs by using an APNs certificate.
	Certificate *string

	// The default authentication method that you want Amazon Pinpoint to use when
	// authenticating with APNs, key or certificate.
	DefaultAuthenticationMethod *string

	// Specifies whether to enable the APNs channel for the application.
	Enabled bool

	// The private key for the APNs client certificate that you want Amazon Pinpoint
	// to use to communicate with APNs.
	PrivateKey *string

	// The identifier that's assigned to your Apple developer account team. This
	// identifier is used for APNs tokens.
	TeamId *string

	// The authentication key to use for APNs tokens.
	TokenKey *string

	// The key identifier that's assigned to your APNs signing key, if you want Amazon
	// Pinpoint to communicate with APNs by using APNs tokens.
	TokenKeyId *string

	noSmithyDocumentSerde
}

// Provides information about the status and settings of the APNs (Apple Push
// Notification service) channel for an application.
type APNSChannelResponse struct {

	// The type of messaging or notification platform for the channel. For the APNs
	// channel, this value is APNS.
	//
	// This member is required.
	Platform *string

	// The unique identifier for the application that the APNs channel applies to.
	ApplicationId *string

	// The date and time when the APNs channel was enabled.
	CreationDate *string

	// The default authentication method that Amazon Pinpoint uses to authenticate
	// with APNs for this channel, key or certificate.
	DefaultAuthenticationMethod *string

	// Specifies whether the APNs channel is enabled for the application.
	Enabled bool

	// (Not used) This property is retained only for backward compatibility.
	HasCredential bool

	// 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.
	HasTokenKey bool

	// (Deprecated) An identifier for the APNs channel. This property is retained only
	// for backward compatibility.
	Id *string

	// Specifies whether the APNs channel is archived.
	IsArchived bool

	// The user who last modified the APNs channel.
	LastModifiedBy *string

	// The date and time when the APNs channel was last modified.
	LastModifiedDate *string

	// The current version of the APNs channel.
	Version int32

	noSmithyDocumentSerde
}

// Specifies the settings for a one-time message that's sent directly to an
// endpoint through the APNs (Apple Push Notification service) channel.
type APNSMessage struct {

	// 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 (https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/sending_notification_requests_to_apns)
	// on the Apple Developer website.
	APNSPushType *string

	// 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.
	Action Action

	// 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.
	Badge int32

	// The body of the notification message.
	Body *string

	// 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.
	Category *string

	// 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.
	CollapseId *string

	// The JSON payload to use for a silent push notification. This payload is added
	// to the data.pinpoint.jsonBody object of the notification.
	Data map[string]string

	// The URL of an image or video to display in the push notification.
	MediaUrl *string

	// The authentication method that you want Amazon Pinpoint to use when
	// authenticating with APNs, CERTIFICATE or TOKEN.
	PreferredAuthenticationMethod *string

	// 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. /para> 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.
	Priority *string

	// The raw, JSON-formatted string to use as the payload for the notification
	// message. If specified, this value overrides all other content for the message.
	// 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 (https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/generating_a_remote_notification)
	// and Pushing Background Updates to Your App (https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/pushing_background_updates_to_your_app)
	// on the Apple Developer website.
	RawContent *string

	// 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 (https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/generating_a_remote_notification)
	// and Pushing Background Updates to Your App (https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/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.
	SilentPush bool

	// 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.
	Sound *string

	// The default message variables to use in the notification message. You can
	// override these default variables with individual address variables.
	Substitutions map[string][]string

	// 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.
	ThreadId *string

	// 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.
	TimeToLive int32

	// The title to display above the notification message on the recipient's device.
	Title *string

	// 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.
	Url *string

	noSmithyDocumentSerde
}

// Specifies channel-specific content and settings for a message template that can
// be used in push notifications that are sent through the APNs (Apple Push
// Notification service) channel.
type APNSPushNotificationTemplate struct {

	// 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.
	Action Action

	// The message body to use in push notifications that are based on the message
	// template.
	Body *string

	// The URL of an image or video to display in push notifications that are based on
	// the message template.
	MediaUrl *string

	// The raw, JSON-formatted string to use as the payload for push notifications
	// that are based on the message template. If specified, this value overrides all
	// other content for the message template.
	RawContent *string

	// The key for the sound to play when the recipient receives a push notification
	// that's based on the message template. The value for this key is the name of a
	// sound file in your app's main bundle or the Library/Sounds folder in your app's
	// data container. If the sound file can't be found or you specify default for the
	// value, the system plays the default alert sound.
	Sound *string

	// The title to use in push notifications that are based on the message template.
	// This title appears above the notification message on a recipient's device.
	Title *string

	// The URL to open in the recipient's default mobile browser, if a recipient taps
	// a push notification that's based on the message template and the value of the
	// Action property is URL.
	Url *string

	noSmithyDocumentSerde
}

// Specifies the status and settings of the APNs (Apple Push Notification service)
// sandbox channel for an application.
type APNSSandboxChannelRequest struct {

	// The bundle identifier that's assigned to your iOS app. This identifier is used
	// for APNs tokens.
	BundleId *string

	// 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.
	Certificate *string

	// The default authentication method that you want Amazon Pinpoint to use when
	// authenticating with the APNs sandbox environment, key or certificate.
	DefaultAuthenticationMethod *string

	// Specifies whether to enable the APNs sandbox channel for the application.
	Enabled bool

	// The private key for the APNs client certificate that you want Amazon Pinpoint
	// to use to communicate with the APNs sandbox environment.
	PrivateKey *string

	// The identifier that's assigned to your Apple developer account team. This
	// identifier is used for APNs tokens.
	TeamId *string

	// The authentication key to use for APNs tokens.
	TokenKey *string

	// 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.
	TokenKeyId *string

	noSmithyDocumentSerde
}

// Provides information about the status and settings of the APNs (Apple Push
// Notification service) sandbox channel for an application.
type APNSSandboxChannelResponse struct {

	// The type of messaging or notification platform for the channel. For the APNs
	// sandbox channel, this value is APNS_SANDBOX.
	//
	// This member is required.
	Platform *string

	// The unique identifier for the application that the APNs sandbox channel applies
	// to.
	ApplicationId *string

	// The date and time when the APNs sandbox channel was enabled.
	CreationDate *string

	// The default authentication method that Amazon Pinpoint uses to authenticate
	// with the APNs sandbox environment for this channel, key or certificate.
	DefaultAuthenticationMethod *string

	// Specifies whether the APNs sandbox channel is enabled for the application.
	Enabled bool

	// (Not used) This property is retained only for backward compatibility.
	HasCredential bool

	// 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.
	HasTokenKey bool

	// (Deprecated) An identifier for the APNs sandbox channel. This property is
	// retained only for backward compatibility.
	Id *string

	// Specifies whether the APNs sandbox channel is archived.
	IsArchived bool

	// The user who last modified the APNs sandbox channel.
	LastModifiedBy *string

	// The date and time when the APNs sandbox channel was last modified.
	LastModifiedDate *string

	// The current version of the APNs sandbox channel.
	Version int32

	noSmithyDocumentSerde
}

// Specifies the status and settings of the APNs (Apple Push Notification service)
// VoIP channel for an application.
type APNSVoipChannelRequest struct {

	// The bundle identifier that's assigned to your iOS app. This identifier is used
	// for APNs tokens.
	BundleId *string

	// The APNs client certificate that you received from Apple, if you want Amazon
	// Pinpoint to communicate with APNs by using an APNs certificate.
	Certificate *string

	// The default authentication method that you want Amazon Pinpoint to use when
	// authenticating with APNs, key or certificate.
	DefaultAuthenticationMethod *string

	// Specifies whether to enable the APNs VoIP channel for the application.
	Enabled bool

	// The private key for the APNs client certificate that you want Amazon Pinpoint
	// to use to communicate with APNs.
	PrivateKey *string

	// The identifier that's assigned to your Apple developer account team. This
	// identifier is used for APNs tokens.
	TeamId *string

	// The authentication key to use for APNs tokens.
	TokenKey *string

	// The key identifier that's assigned to your APNs signing key, if you want Amazon
	// Pinpoint to communicate with APNs by using APNs tokens.
	TokenKeyId *string

	noSmithyDocumentSerde
}

// Provides information about the status and settings of the APNs (Apple Push
// Notification service) VoIP channel for an application.
type APNSVoipChannelResponse struct {

	// The type of messaging or notification platform for the channel. For the APNs
	// VoIP channel, this value is APNS_VOIP.
	//
	// This member is required.
	Platform *string

	// The unique identifier for the application that the APNs VoIP channel applies to.
	ApplicationId *string

	// The date and time when the APNs VoIP channel was enabled.
	CreationDate *string

	// The default authentication method that Amazon Pinpoint uses to authenticate
	// with APNs for this channel, key or certificate.
	DefaultAuthenticationMethod *string

	// Specifies whether the APNs VoIP channel is enabled for the application.
	Enabled bool

	// (Not used) This property is retained only for backward compatibility.
	HasCredential bool

	// 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.
	HasTokenKey bool

	// (Deprecated) An identifier for the APNs VoIP channel. This property is retained
	// only for backward compatibility.
	Id *string

	// Specifies whether the APNs VoIP channel is archived.
	IsArchived bool

	// The user who last modified the APNs VoIP channel.
	LastModifiedBy *string

	// The date and time when the APNs VoIP channel was last modified.
	LastModifiedDate *string

	// The current version of the APNs VoIP channel.
	Version int32

	noSmithyDocumentSerde
}

// Specifies the status and settings of the APNs (Apple Push Notification service)
// VoIP sandbox channel for an application.
type APNSVoipSandboxChannelRequest struct {

	// The bundle identifier that's assigned to your iOS app. This identifier is used
	// for APNs tokens.
	BundleId *string

	// 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.
	Certificate *string

	// The default authentication method that you want Amazon Pinpoint to use when
	// authenticating with the APNs sandbox environment for this channel, key or
	// certificate.
	DefaultAuthenticationMethod *string

	// Specifies whether the APNs VoIP sandbox channel is enabled for the application.
	Enabled bool

	// The private key for the APNs client certificate that you want Amazon Pinpoint
	// to use to communicate with the APNs sandbox environment.
	PrivateKey *string

	// The identifier that's assigned to your Apple developer account team. This
	// identifier is used for APNs tokens.
	TeamId *string

	// The authentication key to use for APNs tokens.
	TokenKey *string

	// 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.
	TokenKeyId *string

	noSmithyDocumentSerde
}

// Provides information about the status and settings of the APNs (Apple Push
// Notification service) VoIP sandbox channel for an application.
type APNSVoipSandboxChannelResponse struct {

	// The type of messaging or notification platform for the channel. For the APNs
	// VoIP sandbox channel, this value is APNS_VOIP_SANDBOX.
	//
	// This member is required.
	Platform *string

	// The unique identifier for the application that the APNs VoIP sandbox channel
	// applies to.
	ApplicationId *string

	// The date and time when the APNs VoIP sandbox channel was enabled.
	CreationDate *string

	// The default authentication method that Amazon Pinpoint uses to authenticate
	// with the APNs sandbox environment for this channel, key or certificate.
	DefaultAuthenticationMethod *string

	// Specifies whether the APNs VoIP sandbox channel is enabled for the application.
	Enabled bool

	// (Not used) This property is retained only for backward compatibility.
	HasCredential bool

	// 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.
	HasTokenKey bool

	// (Deprecated) An identifier for the APNs VoIP sandbox channel. This property is
	// retained only for backward compatibility.
	Id *string

	// Specifies whether the APNs VoIP sandbox channel is archived.
	IsArchived bool

	// The user who last modified the APNs VoIP sandbox channel.
	LastModifiedBy *string

	// The date and time when the APNs VoIP sandbox channel was last modified.
	LastModifiedDate *string

	// The current version of the APNs VoIP sandbox channel.
	Version int32

	noSmithyDocumentSerde
}

// Provides the results of a query that retrieved the data for a standard metric
// that applies to an application, and provides information about that query.
type ApplicationDateRangeKpiResponse struct {

	// The unique identifier for the application that the metric applies to.
	//
	// This member is required.
	ApplicationId *string

	// 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.
	//
	// This member is required.
	EndTime *time.Time

	// 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 (https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html)
	// .
	//
	// This member is required.
	KpiName *string

	// An array of objects that contains the results of the query. Each object
	// contains the value for the metric and metadata about that value.
	//
	// This member is required.
	KpiResult *BaseKpiResult

	// 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.
	//
	// This member is required.
	StartTime *time.Time

	// 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.
	NextToken *string

	noSmithyDocumentSerde
}

// Provides information about an application.
type ApplicationResponse struct {

	// The Amazon Resource Name (ARN) of the application.
	//
	// This member is required.
	Arn *string

	// The unique identifier for the application. This identifier is displayed as the
	// Project ID on the Amazon Pinpoint console.
	//
	// This member is required.
	Id *string

	// The display name of the application. This name is displayed as the Project name
	// on the Amazon Pinpoint console.
	//
	// This member is required.
	Name *string

	// The date and time when the Application was created.
	CreationDate *string

	// 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.
	Tags map[string]string

	noSmithyDocumentSerde
}

// The default sending limits for journeys in the application. To override these
// limits and define custom limits for a specific journey, use the Journey
// resource.
type ApplicationSettingsJourneyLimits struct {

	// 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.
	DailyCap int32

	// The default maximum number of messages that can be sent to an endpoint during
	// the specified timeframe for all journeys.
	TimeframeCap *JourneyTimeframeCap

	// 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.
	TotalCap int32

	noSmithyDocumentSerde
}

// Provides information about an application, including the default settings for
// an application.
type ApplicationSettingsResource struct {

	// The unique identifier for the application. This identifier is displayed as the
	// Project ID on the Amazon Pinpoint console.
	//
	// This member is required.
	ApplicationId *string

	// 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.
	CampaignHook *CampaignHook

	// 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.
	JourneyLimits *ApplicationSettingsJourneyLimits

	// The date and time, in ISO 8601 format, when the application's settings were
	// last modified.
	LastModifiedDate *string

	// The default sending limits for campaigns in the application.
	Limits *CampaignLimits

	// 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.
	QuietTime *QuietTime

	noSmithyDocumentSerde
}

// Provides information about all of your applications.
type ApplicationsResponse struct {

	// An array of responses, one for each application that was returned.
	Item []ApplicationResponse

	// 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.
	NextToken *string

	noSmithyDocumentSerde
}

// Specifies attribute-based criteria for including or excluding endpoints from a
// segment.
type AttributeDimension struct {

	// 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.
	//
	// This member is required.
	Values []string

	// The type of segment dimension to use. Valid values are:
	//   - INCLUSIVE - endpoints that have attributes matching the values are included
	//   in the segment.
	//   - EXCLUSIVE - endpoints that have attributes matching the values are excluded
	//   in the segment.
	//   - CONTAINS - endpoints that have attributes' substrings match the values are
	//   included in the segment.
	//   - BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the
	//   value are included in the segment.
	//   - AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the
	//   value are included in the segment.
	//   - ON - endpoints with attributes read as ISO_INSTANT dates on the value are
	//   included in the segment. Time is ignored in this comparison.
	//   - BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between
	//   the values are included in the segment.
	AttributeType AttributeType

	noSmithyDocumentSerde
}

// Provides information about the type and the names of attributes that were
// removed from all the endpoints that are associated with an application.
type AttributesResource struct {

	// The unique identifier for the application.
	//
	// This member is required.
	ApplicationId *string

	// 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.
	//
	// This member is required.
	AttributeType *string

	// An array that specifies the names of the attributes that were removed from the
	// endpoints.
	Attributes []string

	noSmithyDocumentSerde
}

// Specifies the status and settings of the Baidu (Baidu Cloud Push) channel for
// an application.
type BaiduChannelRequest struct {

	// The API key that you received from the Baidu Cloud Push service to communicate
	// with the service.
	//
	// This member is required.
	ApiKey *string

	// The secret key that you received from the Baidu Cloud Push service to
	// communicate with the service.
	//
	// This member is required.
	SecretKey *string

	// Specifies whether to enable the Baidu channel for the application.
	Enabled bool

	noSmithyDocumentSerde
}

// Provides information about the status and settings of the Baidu (Baidu Cloud
// Push) channel for an application.
type BaiduChannelResponse struct {

	// The API key that you received from the Baidu Cloud Push service to communicate
	// with the service.
	//
	// This member is required.
	Credential *string

	// The type of messaging or notification platform for the channel. For the Baidu
	// channel, this value is BAIDU.
	//
	// This member is required.
	Platform *string

	// The unique identifier for the application that the Baidu channel applies to.
	ApplicationId *string

	// The date and time when the Baidu channel was enabled.
	CreationDate *string

	// Specifies whether the Baidu channel is enabled for the application.
	Enabled bool

	// (Not used) This property is retained only for backward compatibility.
	HasCredential bool

	// (Deprecated) An identifier for the Baidu channel. This property is retained
	// only for backward compatibility.
	Id *string

	// Specifies whether the Baidu channel is archived.
	IsArchived bool

	// The user who last modified the Baidu channel.
	LastModifiedBy *string

	// The date and time when the Baidu channel was last modified.
	LastModifiedDate *string

	// The current version of the Baidu channel.
	Version int32

	noSmithyDocumentSerde
}

// Specifies the settings for a one-time message that's sent directly to an
// endpoint through the Baidu (Baidu Cloud Push) channel.
type BaiduMessage struct {

	// 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.
	Action Action

	// The body of the notification message.
	Body *string

	// 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.
	Data map[string]string

	// The icon image name of the asset saved in your app.
	IconReference *string

	// The URL of the large icon image to display in the content view of the push
	// notification.
	ImageIconUrl *string

	// The URL of an image to display in the push notification.
	ImageUrl *string

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

	// 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.
	SilentPush bool

	// The URL of the small icon image to display in the status bar and the content
	// view of the push notification.
	SmallImageIconUrl *string

	// 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/.
	Sound *string

	// The default message variables to use in the notification message. You can
	// override the default variables with individual address variables.
	Substitutions map[string][]string

	// 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).
	TimeToLive int32

	// The title to display above the notification message on the recipient's device.
	Title *string

	// 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.
	Url *string

	noSmithyDocumentSerde
}

// Provides the results of a query that retrieved the data for a standard metric
// that applies to an application, campaign, or journey.
type BaseKpiResult struct {

	// An array of objects that provides the results of a query that retrieved the
	// data for a standard metric that applies to an application, campaign, or journey.
	//
	// This member is required.
	Rows []ResultRow

	noSmithyDocumentSerde
}

// Specifies the contents of a message that's sent through a custom channel to
// recipients of a campaign.
type CampaignCustomMessage struct {

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

	noSmithyDocumentSerde
}

// Provides the results of a query that retrieved the data for a standard metric
// that applies to a campaign, and provides information about that query.
type CampaignDateRangeKpiResponse struct {

	// The unique identifier for the application that the metric applies to.
	//
	// This member is required.
	ApplicationId *string

	// The unique identifier for the campaign that the metric applies to.
	//
	// This member is required.
	CampaignId *string

	// 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.
	//
	// This member is required.
	EndTime *time.Time

	// 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 (https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html)
	// .
	//
	// This member is required.
	KpiName *string

	// An array of objects that contains the results of the query. Each object
	// contains the value for the metric and metadata about that value.
	//
	// This member is required.
	KpiResult *BaseKpiResult

	// 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.
	//
	// This member is required.
	StartTime *time.Time

	// 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.
	NextToken *string

	noSmithyDocumentSerde
}

// Specifies the content and "From" address for an email message that's sent to
// recipients of a campaign.
type CampaignEmailMessage struct {

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

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

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

	// The subject line, or title, of the email.
	Title *string

	noSmithyDocumentSerde
}

// Specifies the settings for events that cause a campaign to be sent.
type CampaignEventFilter struct {

	// The dimension settings of the event filter for the campaign.
	//
	// This member is required.
	Dimensions *EventDimensions

	// 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.
	//
	// This member is required.
	FilterType FilterType

	noSmithyDocumentSerde
}

// Specifies settings for invoking an AWS Lambda function that customizes a
// segment for a campaign.
type CampaignHook struct {

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

	// The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible
	// values are:
	//   - FILTER - Invoke the function to customize the segment that's used by a
	//   campaign.
	//   - DELIVERY - (Deprecated) Previously, invoked the function to send a campaign
	//   through a custom channel. This functionality is not supported anymore. To send a
	//   campaign through a custom channel, use the CustomDeliveryConfiguration and
	//   CampaignCustomMessage objects of the campaign.
	Mode Mode

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

	noSmithyDocumentSerde
}

// In-app message configuration.
type CampaignInAppMessage struct {

	// The message body of the notification, the email body or the text message.
	Body *string

	// In-app message content.
	Content []InAppMessageContent

	// Custom config to be sent to client.
	CustomConfig map[string]string

	// In-app message layout.
	Layout Layout

	noSmithyDocumentSerde
}

// For a campaign, specifies limits on the messages that the campaign can send.
// For an application, specifies the default limits for messages that campaigns in
// the application can send.
type CampaignLimits struct {

	// 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.
	Daily int32

	// 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.
	MaximumDuration int32

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

	// The maximum total number of messages that the campaign can send per user
	// session.
	Session int32

	// 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.
	Total int32

	noSmithyDocumentSerde
}

// Provides information about the status, configuration, and other settings for a
// campaign.
type CampaignResponse struct {

	// The unique identifier for the application that the campaign applies to.
	//
	// This member is required.
	ApplicationId *string

	// The Amazon Resource Name (ARN) of the campaign.
	//
	// This member is required.
	Arn *string

	// The date, in ISO 8601 format, when the campaign was created.
	//
	// This member is required.
	CreationDate *string

	// The unique identifier for the campaign.
	//
	// This member is required.
	Id *string

	// The date, in ISO 8601 format, when the campaign was last modified.
	//
	// This member is required.
	LastModifiedDate *string

	// The unique identifier for the segment that's associated with the campaign.
	//
	// This member is required.
	SegmentId *string

	// The version number of the segment that's associated with the campaign.
	//
	// This member is required.
	SegmentVersion int32

	// An array of responses, one for each treatment that you defined for the
	// campaign, in addition to the default treatment.
	AdditionalTreatments []TreatmentResource

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

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

	// The custom description of the campaign.
	Description *string

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

	// 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.
	Hook *CampaignHook

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

	// The messaging limits for the campaign.
	Limits *CampaignLimits

	// The message configuration settings for the campaign.
	MessageConfiguration *MessageConfiguration

	// The name of the campaign.
	Name *string

	// 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.
	Priority int32

	// The schedule settings for the campaign.
	Schedule *Schedule

	// The current status of the campaign.
	State *CampaignState

	// 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.
	Tags map[string]string

	// The message template that’s used for the campaign.
	TemplateConfiguration *TemplateConfiguration

	// The custom description of the default treatment for the campaign.
	TreatmentDescription *string

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

	// The version number of the campaign.
	Version int32

	noSmithyDocumentSerde
}

// Specifies the content and settings for an SMS message that's sent to recipients
// of a campaign.
type CampaignSmsMessage struct {

	// The body of the SMS message.
	Body *string

	// The entity ID or Principal Entity (PE) id received from the regulatory body for
	// sending SMS in your country.
	EntityId *string

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

	// 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.
	OriginationNumber *string

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

	// The template ID received from the regulatory body for sending SMS in your
	// country.
	TemplateId *string

	noSmithyDocumentSerde
}

// Provides information about the configuration and other settings for all the
// campaigns that are associated with an application.
type CampaignsResponse struct {

	// An array of responses, one for each campaign that's associated with the
	// application.
	//
	// This member is required.
	Item []CampaignResponse

	// 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.
	NextToken *string

	noSmithyDocumentSerde
}

// Provides information about the status of a campaign.
type CampaignState struct {

	// 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.
	CampaignStatus CampaignStatus

	noSmithyDocumentSerde
}

// Provides information about the general settings and status of a channel for an
// application.
type ChannelResponse struct {

	// The unique identifier for the application.
	ApplicationId *string

	// The date and time, in ISO 8601 format, when the channel was enabled.
	CreationDate *string

	// Specifies whether the channel is enabled for the application.
	Enabled bool

	// (Not used) This property is retained only for backward compatibility.
	HasCredential bool

	// (Deprecated) An identifier for the channel. This property is retained only for
	// backward compatibility.
	Id *string

	// Specifies whether the channel is archived.
	IsArchived bool

	// The user who last modified the channel.
	LastModifiedBy *string

	// The date and time, in ISO 8601 format, when the channel was last modified.
	LastModifiedDate *string

	// The current version of the channel.
	Version int32

	noSmithyDocumentSerde
}

// Provides information about the general settings and status of all channels for
// an application, including channels that aren't enabled for the application.
type ChannelsResponse struct {

	// A map that contains a multipart response for each channel. For each item in
	// this object, the ChannelType is the key and the Channel is the value.
	//
	// This member is required.
	Channels map[string]ChannelResponse

	noSmithyDocumentSerde
}

// The time when a journey will not send messages. QuietTime should be configured
// first and SendingSchedule should be set to true.
type ClosedDays struct {

	// Rules for the Custom channel.
	CUSTOM []ClosedDaysRule

	// Rules for the Email channel.
	EMAIL []ClosedDaysRule

	// Rules for the Push channel.
	PUSH []ClosedDaysRule

	// Rules for the SMS channel.
	SMS []ClosedDaysRule

	// Rules for the Voice channel.
	VOICE []ClosedDaysRule

	noSmithyDocumentSerde
}

// Specifies the rule settings for when messages can't be sent.
type ClosedDaysRule struct {

	// End DateTime ISO 8601 format
	EndDateTime *string

	// The name of the closed day rule.
	Name *string

	// Start DateTime ISO 8601 format
	StartDateTime *string

	noSmithyDocumentSerde
}

// Specifies the conditions to evaluate for an activity in a journey, and how to
// evaluate those conditions.
type Condition struct {

	// The conditions to evaluate for the activity.
	Conditions []SimpleCondition

	// 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.
	Operator Operator

	noSmithyDocumentSerde
}

// Specifies the settings for a yes/no split activity in a journey. This type of
// activity sends participants down one of two paths in a journey, based on
// conditions that you specify. To create yes/no split activities that send
// participants down different paths based on push notification events (such as
// Open or Received events), your mobile app has to specify the User ID and
// Endpoint ID values. For more information, see Integrating Amazon Pinpoint with
// your application (https://docs.aws.amazon.com/pinpoint/latest/developerguide/integrate.html)
// in the Amazon Pinpoint Developer Guide.
type ConditionalSplitActivity struct {

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

	// 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.
	EvaluationWaitTime *WaitTime

	// The unique identifier for the activity to perform if the conditions aren't met.
	FalseActivity *string

	// The unique identifier for the activity to perform if the conditions are met.
	TrueActivity *string

	noSmithyDocumentSerde
}

type ContactCenterActivity struct {

	// The unique identifier for the next activity to perform after the this activity.
	NextActivity *string

	noSmithyDocumentSerde
}

// Specifies the display name of an application and the tags to associate with the
// application.
type CreateApplicationRequest struct {

	// The display name of the application. This name is displayed as the Project name
	// on the Amazon Pinpoint console.
	//
	// This member is required.
	Name *string

	// 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.
	Tags map[string]string

	noSmithyDocumentSerde
}

// Specifies Amazon Pinpoint configuration settings for retrieving and processing
// recommendation data from a recommender model.
type CreateRecommenderConfigurationShape struct {

	// 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.
	//
	// This member is required.
	RecommendationProviderRoleArn *string

	// 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.
	//
	// This member is required.
	RecommendationProviderUri *string

	// 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.
	Attributes map[string]string

	// A custom description of the configuration for the recommender model. The
	// description can contain up to 128 characters. The characters can be letters,
	// numbers, spaces, or the following symbols: _ ; () , ‐.
	Description *string

	// A custom name of the configuration for the recommender model. The name must
	// start with a letter or number and it can contain up to 128 characters. The
	// characters can be letters, numbers, spaces, underscores (_), or hyphens (-).
	Name *string

	// The type of Amazon Pinpoint ID to associate with unique user IDs in the
	// recommender model. This value enables the model to use attribute and event data
	// that’s specific to a particular endpoint or user in an Amazon Pinpoint
	// application. Valid values are:
	//   - PINPOINT_ENDPOINT_ID - Associate each user in the model with a particular
	//   endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in
	//   Amazon Pinpoint. This is the default value.
	//   - PINPOINT_USER_ID - Associate each user in the model with a particular user
	//   and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in
	//   Amazon Pinpoint. If you specify this value, an endpoint definition in Amazon
	//   Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise,
	//   messages won’t be sent to the user's endpoint.
	RecommendationProviderIdType *string

	// The name or Amazon Resource Name (ARN) of the AWS Lambda function to invoke for
	// additional processing of recommendation data that's retrieved from the
	// recommender model.
	RecommendationTransformerUri *string

	// A custom display name for the standard endpoint or user attribute
	// (RecommendationItems) that temporarily stores recommended items for each
	// endpoint or user, depending on the value for the RecommendationProviderIdType
	// property. This value is required if the configuration doesn't invoke an AWS
	// Lambda function (RecommendationTransformerUri) to perform additional processing
	// of recommendation data. This name appears in the Attribute finder of the
	// template editor on the Amazon Pinpoint console. The name can contain up to 25
	// characters. The characters can be letters, numbers, spaces, underscores (_), or
	// hyphens (-). These restrictions don't apply to attribute values.
	RecommendationsDisplayName *string

	// 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.
	RecommendationsPerMessage int32

	noSmithyDocumentSerde
}

// Provides information about a request to create a message template.
type CreateTemplateMessageBody struct {

	// The Amazon Resource Name (ARN) of the message template that was created.
	Arn *string

	// The message that's returned from the API for the request to create the message
	// template.
	Message *string

	// The unique identifier for the request to create the message template.
	RequestID *string

	noSmithyDocumentSerde
}

// Specifies the delivery configuration settings for sending a campaign or
// campaign treatment through a custom channel. This object is required if you use
// the CampaignCustomMessage object to define the message to send for the campaign
// or campaign treatment.
type CustomDeliveryConfiguration struct {

	// 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.
	//
	// This member is required.
	DeliveryUri *string

	// 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.
	EndpointTypes []EndpointTypesElement

	noSmithyDocumentSerde
}

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

	// 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.
	DeliveryUri *string

	// 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.
	EndpointTypes []EndpointTypesElement

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

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

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

	// The unique identifier for the version of the message template to use for the
	// message. If specified, this value must match the identifier for an existing
	// template version. To retrieve a list of versions and version identifiers for a
	// template, use the Template 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.
	TemplateVersion *string

	noSmithyDocumentSerde
}

// Default button configuration.
type DefaultButtonConfiguration struct {

	// Action triggered by the button.
	//
	// This member is required.
	ButtonAction ButtonAction

	// Button text.
	//
	// This member is required.
	Text *string

	// The background color of the button.
	BackgroundColor *string

	// The border radius of the button.
	BorderRadius int32

	// Button destination.
	Link *string

	// The text color of the button.
	TextColor *string

	noSmithyDocumentSerde
}

// Specifies the default message for all channels.
type DefaultMessage struct {

	// The default body of the message.
	Body *string

	// The default message variables to use in the message. You can override these
	// default variables with individual address variables.
	Substitutions map[string][]string

	noSmithyDocumentSerde
}

// Specifies the default settings and content for a push notification that's sent
// directly to an endpoint.
type DefaultPushNotificationMessage struct {

	// 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.
	Action Action

	// The default body of the notification message.
	Body *string

	// 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.
	Data map[string]string

	// 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.
	SilentPush bool

	// The default message variables to use in the notification message. You can
	// override the default variables with individual address variables.
	Substitutions map[string][]string

	// The default title to display above the notification message on a recipient's
	// device.
	Title *string

	// 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.
	Url *string

	noSmithyDocumentSerde
}

// Specifies the default settings and content for a message template that can be
// used in messages that are sent through a push notification channel.
type DefaultPushNotificationTemplate struct {

	// 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.
	Action Action

	// The message body to use in push notifications that are based on the message
	// template.
	Body *string

	// The sound to play when a recipient receives a push notification that's based on
	// the message template. You can use the default stream or specify the file name of
	// a sound resource that's bundled in your app. On an Android platform, the sound
	// file must reside in /res/raw/. For an iOS platform, this value is the key for
	// the name of a sound file in your app's main bundle or the Library/Sounds folder
	// in your app's data container. If the sound file can't be found or you specify
	// default for the value, the system plays the default alert sound.
	Sound *string

	// The title to use in push notifications that are based on the message template.
	// This title appears above the notification message on a recipient's device.
	Title *string

	// The URL to open in a recipient's default mobile browser, if a recipient taps a
	// push notification that's based on the message template and the value of the
	// Action property is URL.
	Url *string

	noSmithyDocumentSerde
}

// Specifies the settings and content for the default message and any default
// messages that you tailored for specific channels.
type DirectMessageConfiguration struct {

	// The default push notification message for the ADM (Amazon Device Messaging)
	// channel. This message overrides the default push notification message
	// (DefaultPushNotificationMessage).
	ADMMessage *ADMMessage

	// The default push notification message for the APNs (Apple Push Notification
	// service) channel. This message overrides the default push notification message
	// (DefaultPushNotificationMessage).
	APNSMessage *APNSMessage

	// The default push notification message for the Baidu (Baidu Cloud Push) channel.
	// This message overrides the default push notification message
	// (DefaultPushNotificationMessage).
	BaiduMessage *BaiduMessage

	// The default message for all channels.
	DefaultMessage *DefaultMessage

	// The default push notification message for all push notification channels.
	DefaultPushNotificationMessage *DefaultPushNotificationMessage

	// The default message for the email channel. This message overrides the default
	// message (DefaultMessage).
	EmailMessage *EmailMessage

	// 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).
	GCMMessage *GCMMessage

	// The default message for the SMS channel. This message overrides the default
	// message (DefaultMessage).
	SMSMessage *SMSMessage

	// The default message for the voice channel. This message overrides the default
	// message (DefaultMessage).
	VoiceMessage *VoiceMessage

	noSmithyDocumentSerde
}

// Specifies the status and settings of the email channel for an application.
type EmailChannelRequest struct {

	// The verified email address that you want to send email from when you send email
	// through the channel.
	//
	// This member is required.
	FromAddress *string

	// 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.
	//
	// This member is required.
	Identity *string

	// The Amazon SES configuration set (https://docs.aws.amazon.com/ses/latest/APIReference/API_ConfigurationSet.html)
	// that you want to apply to messages that you send through the channel.
	ConfigurationSet *string

	// Specifies whether to enable the email channel for the application.
	Enabled bool

	// 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.
	RoleArn *string

	noSmithyDocumentSerde
}

// Provides information about the status and settings of the email channel for an
// application.
type EmailChannelResponse struct {

	// The type of messaging or notification platform for the channel. For the email
	// channel, this value is EMAIL.
	//
	// This member is required.
	Platform *string

	// The unique identifier for the application that the email channel applies to.
	ApplicationId *string

	// The Amazon SES configuration set (https://docs.aws.amazon.com/ses/latest/APIReference/API_ConfigurationSet.html)
	// that's applied to messages that are sent through the channel.
	ConfigurationSet *string

	// The date and time, in ISO 8601 format, when the email channel was enabled.
	CreationDate *string

	// Specifies whether the email channel is enabled for the application.
	Enabled bool

	// The verified email address that email is sent from when you send email through
	// the channel.
	FromAddress *string

	// (Not used) This property is retained only for backward compatibility.
	HasCredential bool

	// (Deprecated) An identifier for the email channel. This property is retained
	// only for backward compatibility.
	Id *string

	// The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple
	// Email Service (Amazon SES), that's used when you send email through the channel.
	Identity *string

	// Specifies whether the email channel is archived.
	IsArchived bool

	// The user who last modified the email channel.
	LastModifiedBy *string

	// The date and time, in ISO 8601 format, when the email channel was last modified.
	LastModifiedDate *string

	// The maximum number of emails that can be sent through the channel each second.
	MessagesPerSecond int32

	// The ARN of the AWS Identity and Access Management (IAM) role that Amazon
	// Pinpoint uses to submit email-related event data for the channel.
	RoleArn *string

	// The current version of the email channel.
	Version int32

	noSmithyDocumentSerde
}

// Specifies the default settings and content for a one-time email message that's
// sent directly to an endpoint.
type EmailMessage struct {

	// The body of the email message.
	Body *string

	// The email address to forward bounces and complaints to, if feedback forwarding
	// is enabled.
	FeedbackForwardingAddress *string

	// The verified email address to send the email message from. The default value is
	// the FromAddress specified for the email channel.
	FromAddress *string

	// The email message, represented as a raw MIME message.
	RawEmail *RawEmail

	// The reply-to email address(es) for the email message. If a recipient replies to
	// the email, each reply-to address receives the reply.
	ReplyToAddresses []string

	// The email message, composed of a subject, a text part, and an HTML part.
	SimpleEmail *SimpleEmail

	// The default message variables to use in the email message. You can override the
	// default variables with individual address variables.
	Substitutions map[string][]string

	noSmithyDocumentSerde
}

// Specifies the settings for an email activity in a journey. This type of
// activity sends an email message to participants.
type EmailMessageActivity struct {

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

	// The unique identifier for the next activity to perform, after the message is
	// sent.
	NextActivity *string

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

	// The unique identifier for the version of the email template to use for the
	// message. If specified, this value must match the identifier for an existing
	// template version. To retrieve a list of versions and version identifiers for a
	// template, use the Template 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.
	TemplateVersion *string

	noSmithyDocumentSerde
}

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

	// 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.
	DefaultSubstitutions *string

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

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

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

	// As of 22-05-2023 tags has been deprecated for update operations. After this
	// date any value in tags is not processed and an error code is not returned. To
	// manage tags we recommend using either Tags (https://docs.aws.amazon.com/pinpoint/latest/apireference/tags-resource-arn.html)
	// in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi (https://docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/index.html)
	// commands in the AWS Command Line Interface Documentation or
	// resourcegroupstaggingapi (https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/resourcegroupstaggingapi/package-summary.html)
	// 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.
	Tags map[string]string

	// A custom description of the message template.
	TemplateDescription *string

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

	noSmithyDocumentSerde
}

// Provides information about the content and settings for a message template that
// can be used in messages that are sent through the email channel.
type EmailTemplateResponse struct {

	// The date, in ISO 8601 format, when the message template was created.
	//
	// This member is required.
	CreationDate *string

	// The date, in ISO 8601 format, when the message template was last modified.
	//
	// This member is required.
	LastModifiedDate *string

	// The name of the message template.
	//
	// This member is required.
	TemplateName *string

	// The type of channel that the message template is designed for. For an email
	// template, this value is EMAIL.
	//
	// This member is required.
	TemplateType TemplateType

	// The Amazon Resource Name (ARN) of the message template.
	Arn *string

	// 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.
	DefaultSubstitutions *string

	// The message body, in HTML format, that's used in email messages that are based
	// on the message template.
	HtmlPart *string

	// The unique identifier for the recommender model that's used by the message
	// template.
	RecommenderId *string

	// The subject line, or title, that's used in email messages that are based on the
	// message template.
	Subject *string

	// 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.
	Tags map[string]string

	// The custom description of the message template.
	TemplateDescription *string

	// The message body, in plain text format, that's used in email messages that are
	// based on the message template.
	TextPart *string

	// 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.
	Version *string

	noSmithyDocumentSerde
}

// Specifies an endpoint to create or update and the settings and attributes to
// set or change for the endpoint.
type EndpointBatchItem struct {

	// 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.
	Address *string

	// 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.
	Attributes map[string][]string

	// The channel to use when sending messages or push notifications to the endpoint.
	ChannelType ChannelType

	// The demographic information for the endpoint, such as the time zone and
	// platform.
	Demographic *EndpointDemographic

	// The date and time, in ISO 8601 format, when the endpoint was created or updated.
	EffectiveDate *string

	// 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.
	EndpointStatus *string

	// The unique identifier for the endpoint in the context of the batch.
	Id *string

	// The geographic information for the endpoint.
	Location *EndpointLocation

	// One or more custom metrics that your app reports to Amazon Pinpoint for the
	// endpoint.
	Metrics map[string]float64

	// 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.
	OptOut *string

	// The unique identifier for the request to create or update the endpoint.
	RequestId *string

	// One or more custom attributes that describe the user who's associated with the
	// endpoint.
	User *EndpointUser

	noSmithyDocumentSerde
}

// Specifies a batch of endpoints to create or update and the settings and
// attributes to set or change for each endpoint.
type EndpointBatchRequest struct {

	// An array that defines the endpoints to create or update and, for each endpoint,
	// the property values to set or change. An array can contain a maximum of 100
	// items.
	//
	// This member is required.
	Item []EndpointBatchItem

	noSmithyDocumentSerde
}

// Specifies demographic information about an endpoint, such as the applicable
// time zone and platform.
type EndpointDemographic struct {

	// The version of the app that's associated with the endpoint.
	AppVersion *string

	// The locale of the endpoint, in the following format: the ISO 639-1 alpha-2
	// code, followed by an underscore (_), followed by an ISO 3166-1 alpha-2 value.
	Locale *string

	// The manufacturer of the endpoint device, such as apple or samsung.
	Make *string

	// The model name or number of the endpoint device, such as iPhone or SM-G900F.
	Model *string

	// The model version of the endpoint device.
	ModelVersion *string

	// The platform of the endpoint device, such as ios.
	Platform *string

	// The platform version of the endpoint device.
	PlatformVersion *string

	// The time zone of the endpoint, specified as a tz database name value, such as
	// America/Los_Angeles.
	Timezone *string

	noSmithyDocumentSerde
}

// Provides the status code and message that result from processing data for an
// endpoint.
type EndpointItemResponse struct {

	// The custom message that's returned in the response as a result of processing
	// the endpoint data.
	Message *string

	// The status code that's returned in the response as a result of processing the
	// endpoint data.
	StatusCode int32

	noSmithyDocumentSerde
}

// Specifies geographic information about an endpoint.
type EndpointLocation struct {

	// The name of the city where the endpoint is located.
	City *string

	// The two-character code, in ISO 3166-1 alpha-2 format, for the country or region
	// where the endpoint is located. For example, US for the United States.
	Country *string

	// The latitude coordinate of the endpoint location, rounded to one decimal place.
	Latitude float64

	// The longitude coordinate of the endpoint location, rounded to one decimal place.
	Longitude float64

	// The postal or ZIP code for the area where the endpoint is located.
	PostalCode *string

	// The name of the region where the endpoint is located. For locations in the
	// United States, this value is the name of a state.
	Region *string

	noSmithyDocumentSerde
}

// Provides information about the delivery status and results of sending a message
// directly to an endpoint.
type EndpointMessageResult struct {

	// 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.
	//   - TIMEOUT - The message couldn't be sent within the timeout period.
	//   - UNKNOWN_FAILURE - An unknown error occurred.
	//
	// This member is required.
	DeliveryStatus DeliveryStatus

	// The downstream service status code for delivering the message.
	//
	// This member is required.
	StatusCode int32

	// The endpoint address that the message was delivered to.
	Address *string

	// The unique identifier for the message that was sent.
	MessageId *string

	// The status message for delivering the message.
	StatusMessage *string

	// 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.
	UpdatedToken *string

	noSmithyDocumentSerde
}

// Specifies the channel type and other settings for an endpoint.
type EndpointRequest struct {

	// 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.
	Address *string

	// 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.
	Attributes map[string][]string

	// The channel to use when sending messages or push notifications to the endpoint.
	ChannelType ChannelType

	// The demographic information for the endpoint, such as the time zone and
	// platform.
	Demographic *EndpointDemographic

	// The date and time, in ISO 8601 format, when the endpoint is updated.
	EffectiveDate *string

	// 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.
	EndpointStatus *string

	// The geographic information for the endpoint.
	Location *EndpointLocation

	// One or more custom metrics that your app reports to Amazon Pinpoint for the
	// endpoint.
	Metrics map[string]float64

	// 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.
	OptOut *string

	// The unique identifier for the most recent request to update the endpoint.
	RequestId *string

	// One or more custom attributes that describe the user who's associated with the
	// endpoint.
	User *EndpointUser

	noSmithyDocumentSerde
}

// Provides information about the channel type and other settings for an endpoint.
type EndpointResponse struct {

	// 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.
	Address *string

	// The unique identifier for the application that's associated with the endpoint.
	ApplicationId *string

	// 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.
	Attributes map[string][]string

	// The channel that's used when sending messages or push notifications to the
	// endpoint.
	ChannelType ChannelType

	// 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.
	CohortId *string

	// The date and time, in ISO 8601 format, when the endpoint was created.
	CreationDate *string

	// The demographic information for the endpoint, such as the time zone and
	// platform.
	Demographic *EndpointDemographic

	// The date and time, in ISO 8601 format, when the endpoint was last updated.
	EffectiveDate *string

	// Specifies whether messages or push notifications are sent to the endpoint.
	// Possible values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE,
	// messages aren’t sent to the endpoint. Amazon Pinpoint automatically sets this
	// value to ACTIVE when you create an endpoint or update an existing endpoint.
	// Amazon Pinpoint automatically sets this value to INACTIVE if you update another
	// endpoint that has the same address specified by the Address property.
	EndpointStatus *string

	// The unique identifier that you assigned to the endpoint. The identifier should
	// be a globally unique identifier (GUID) to ensure that it doesn't conflict with
	// other endpoint identifiers that are associated with the application.
	Id *string

	// The geographic information for the endpoint.
	Location *EndpointLocation

	// One or more custom metrics that your app reports to Amazon Pinpoint for the
	// endpoint.
	Metrics map[string]float64

	// 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.
	OptOut *string

	// The unique identifier for the most recent request to update the endpoint.
	RequestId *string

	// One or more custom user attributes that your app reports to Amazon Pinpoint for
	// the user who's associated with the endpoint.
	User *EndpointUser

	noSmithyDocumentSerde
}

// Specifies the content, including message variables and attributes, to use in a
// message that's sent directly to an endpoint.
type EndpointSendConfiguration struct {

	// The body of the message. If specified, this value overrides the default message
	// body.
	BodyOverride *string

	// 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.
	Context map[string]string

	// The raw, JSON-formatted string to use as the payload for the message. If
	// specified, this value overrides all other values for the message.
	RawContent *string

	// 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.
	Substitutions map[string][]string

	// The title or subject line of the message. If specified, this value overrides
	// the default message title or subject line.
	TitleOverride *string

	noSmithyDocumentSerde
}

// Provides information about all the endpoints that are associated with a user ID.
type EndpointsResponse struct {

	// An array of responses, one for each endpoint that's associated with the user ID.
	//
	// This member is required.
	Item []EndpointResponse

	noSmithyDocumentSerde
}

// Specifies data for one or more attributes that describe the user who's
// associated with an endpoint.
type EndpointUser struct {

	// 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.
	UserAttributes map[string][]string

	// The unique identifier for the user.
	UserId *string

	noSmithyDocumentSerde
}

// Specifies information about an event that reports data to Amazon Pinpoint.
type Event struct {

	// The name of the event.
	//
	// This member is required.
	EventType *string

	// The date and time, in ISO 8601 format, when the event occurred.
	//
	// This member is required.
	Timestamp *string

	// The package name of the app that's recording the event.
	AppPackageName *string

	// The title of the app that's recording the event.
	AppTitle *string

	// The version number of the app that's recording the event.
	AppVersionCode *string

	// One or more custom attributes that are associated with the event.
	Attributes map[string]string

	// The version of the SDK that's running on the client device.
	ClientSdkVersion *string

	// One or more custom metrics that are associated with the event.
	Metrics map[string]float64

	// The name of the SDK that's being used to record the event.
	SdkName *string

	// Information about the session in which the event occurred.
	Session *Session

	noSmithyDocumentSerde
}

// Specifies the conditions to evaluate for an event that applies to an activity
// in a journey.
type EventCondition struct {

	// The dimensions for the event filter to use for the activity.
	Dimensions *EventDimensions

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

	noSmithyDocumentSerde
}

// Specifies the dimensions for an event filter that determines when a campaign is
// sent or a journey activity is performed.
type EventDimensions struct {

	// 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.
	Attributes map[string]AttributeDimension

	// 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 (https://docs.aws.amazon.com/pinpoint/latest/developerguide/event-streams.html)
	// in the Amazon Pinpoint Developer Guide.
	EventType *SetDimension

	// 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.
	Metrics map[string]MetricDimension

	noSmithyDocumentSerde
}

// Specifies the settings for an event that causes a campaign to be sent or a
// journey activity to be performed.
type EventFilter struct {

	// The dimensions for the event filter to use for the campaign or the journey
	// activity.
	//
	// This member is required.
	Dimensions *EventDimensions

	// 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.
	//
	// This member is required.
	FilterType FilterType

	noSmithyDocumentSerde
}

// Provides the status code and message that result from processing an event.
type EventItemResponse struct {

	// A custom message that's returned in the response as a result of processing the
	// event.
	Message *string

	// 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.
	StatusCode int32

	noSmithyDocumentSerde
}

// Specifies a batch of endpoints and events to process.
type EventsBatch struct {

	// A set of properties and attributes that are associated with the endpoint.
	//
	// This member is required.
	Endpoint *PublicEndpoint

	// A set of properties that are associated with the event.
	//
	// This member is required.
	Events map[string]Event

	noSmithyDocumentSerde
}

// Specifies a batch of events to process.
type EventsRequest struct {

	// The batch of events to process. For each item in a batch, the endpoint ID acts
	// as a key that has an EventsBatch object as its value.
	//
	// This member is required.
	BatchItem map[string]EventsBatch

	noSmithyDocumentSerde
}

// Provides information about endpoints and the events that they're associated
// with.
type EventsResponse struct {

	// 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.
	Results map[string]ItemResponse

	noSmithyDocumentSerde
}

// Specifies the settings for an event that causes a journey activity to start.
type EventStartCondition struct {

	// Specifies the settings for an event that causes a campaign to be sent or a
	// journey activity to be performed.
	EventFilter *EventFilter

	SegmentId *string

	noSmithyDocumentSerde
}

// Specifies settings for publishing event data to an Amazon Kinesis data stream
// or an Amazon Kinesis Data Firehose delivery stream.
type EventStream struct {

	// The unique identifier for the application to publish event data for.
	//
	// This member is required.
	ApplicationId *string

	// The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon
	// Kinesis Data Firehose delivery stream to publish event data to. For a Kinesis
	// data stream, the ARN format is:
	// arn:aws:kinesis:region:account-id:stream/stream_name For a Kinesis Data Firehose
	// delivery stream, the ARN format is:
	// arn:aws:firehose:region:account-id:deliverystream/stream_name
	//
	// This member is required.
	DestinationStreamArn *string

	// The AWS Identity and Access Management (IAM) role that authorizes Amazon
	// Pinpoint to publish event data to the stream in your AWS account.
	//
	// This member is required.
	RoleArn *string

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

	// The date, in ISO 8601 format, when the event stream was last modified.
	LastModifiedDate *string

	// The IAM user who last modified the event stream.
	LastUpdatedBy *string

	noSmithyDocumentSerde
}

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

	// 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.
	//
	// This member is required.
	RoleArn *string

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

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

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

	noSmithyDocumentSerde
}

// Provides information about the resource settings for a job that exports
// endpoint definitions to a file. The file can be added directly to an Amazon
// Simple Storage Service (Amazon S3) bucket by using the Amazon Pinpoint API or
// downloaded directly to a computer by using the Amazon Pinpoint console.
type ExportJobResource struct {

	// 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.
	//
	// This member is required.
	RoleArn *string

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

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

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

	noSmithyDocumentSerde
}

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

	// The unique identifier for the application that's associated with the export job.
	//
	// This member is required.
	ApplicationId *string

	// The date, in ISO 8601 format, when the export job was created.
	//
	// This member is required.
	CreationDate *string

	// The resource settings that apply to the export job.
	//
	// This member is required.
	Definition *ExportJobResource

	// The unique identifier for the export job.
	//
	// This member is required.
	Id *string

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

	// The job type. This value is EXPORT for export jobs.
	//
	// This member is required.
	Type *string

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

	// The date, in ISO 8601 format, when the export job was completed.
	CompletionDate *string

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

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

	// 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.
	TotalFailures int32

	// 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.
	TotalPieces int32

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

	noSmithyDocumentSerde
}

// Provides information about all the export jobs that are associated with an
// application or segment. An export job is a job that exports endpoint definitions
// to a file.
type ExportJobsResponse struct {

	// An array of responses, one for each export job that's associated with the
	// application (Export Jobs resource) or segment (Segment Export Jobs resource).
	//
	// This member is required.
	Item []ExportJobResponse

	// 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.
	NextToken *string

	noSmithyDocumentSerde
}

// Specifies the status and settings of the GCM channel for an application. This
// channel enables Amazon Pinpoint to send push notifications through the Firebase
// Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.
type GCMChannelRequest struct {

	// The Web API Key, also referred to as an API_KEY or server key, that you
	// received from Google to communicate with Google services.
	ApiKey *string

	// The default authentication method used for GCM. Values are either "TOKEN" or
	// "KEY". Defaults to "KEY".
	DefaultAuthenticationMethod *string

	// Specifies whether to enable the GCM channel for the application.
	Enabled bool

	// 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 (https://firebase.google.com/docs/cloud-messaging/migrate-v1)
	// .
	ServiceJson *string

	noSmithyDocumentSerde
}

// Provides information about the status and settings of the GCM channel for an
// application. The GCM channel enables Amazon Pinpoint to send push notifications
// through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging
// (GCM), service.
type GCMChannelResponse struct {

	// The type of messaging or notification platform for the channel. For the GCM
	// channel, this value is GCM.
	//
	// This member is required.
	Platform *string

	// The unique identifier for the application that the GCM channel applies to.
	ApplicationId *string

	// The date and time when the GCM channel was enabled.
	CreationDate *string

	// The Web API Key, also referred to as an API_KEY or server key, that you
	// received from Google to communicate with Google services.
	Credential *string

	// The default authentication method used for GCM. Values are either "TOKEN" or
	// "KEY". Defaults to "KEY".
	DefaultAuthenticationMethod *string

	// Specifies whether the GCM channel is enabled for the application.
	Enabled bool

	// (Not used) This property is retained only for backward compatibility.
	HasCredential bool

	// Returns true if the JSON file provided by Google during registration process
	// was used in the ServiceJson field of the request.
	HasFcmServiceCredentials bool

	// (Deprecated) An identifier for the GCM channel. This property is retained only
	// for backward compatibility.
	Id *string

	// Specifies whether the GCM channel is archived.
	IsArchived bool

	// The user who last modified the GCM channel.
	LastModifiedBy *string

	// The date and time when the GCM channel was last modified.
	LastModifiedDate *string

	// The current version of the GCM channel.
	Version int32

	noSmithyDocumentSerde
}

// Specifies the settings for a one-time message that's sent directly to an
// endpoint through the GCM channel. The GCM channel enables Amazon Pinpoint to
// send messages to the Firebase Cloud Messaging (FCM), formerly Google Cloud
// Messaging (GCM), service.
type GCMMessage struct {

	// 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.
	Action Action

	// The body of the notification message.
	Body *string

	// 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.
	CollapseKey *string

	// 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.
	Data map[string]string

	// The icon image name of the asset saved in your app.
	IconReference *string

	// The URL of the large icon image to display in the content view of the push
	// notification.
	ImageIconUrl *string

	// The URL of an image to display in the push notification.
	ImageUrl *string

	// The preferred authentication method, with valid values "KEY" or "TOKEN". If a
	// value isn't provided then the DefaultAuthenticationMethod is used.
	PreferredAuthenticationMethod *string

	// 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. /para> 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.
	Priority *string

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

	// The package name of the application where registration tokens must match in
	// order for the recipient to receive the message.
	RestrictedPackageName *string

	// 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.
	SilentPush bool

	// The URL of the small icon image to display in the status bar and the content
	// view of the push notification.
	SmallImageIconUrl *string

	// 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/.
	Sound *string

	// The default message variables to use in the notification message. You can
	// override the default variables with individual address variables.
	Substitutions map[string][]string

	// 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.
	TimeToLive int32

	// The title to display above the notification message on the recipient's device.
	Title *string

	// 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.
	Url *string

	noSmithyDocumentSerde
}

// Specifies the GPS coordinates of a location.
type GPSCoordinates struct {

	// The latitude coordinate of the location.
	//
	// This member is required.
	Latitude float64

	// The longitude coordinate of the location.
	//
	// This member is required.
	Longitude float64

	noSmithyDocumentSerde
}

// Specifies GPS-based criteria for including or excluding endpoints from a
// segment.
type GPSPointDimension struct {

	// The GPS coordinates to measure distance from.
	//
	// This member is required.
	Coordinates *GPSCoordinates

	// The range, in kilometers, from the GPS coordinates.
	RangeInKilometers float64

	noSmithyDocumentSerde
}

// Specifies the settings for a holdout activity in a journey. This type of
// activity stops a journey for a specified percentage of participants.
type HoldoutActivity struct {

	// 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.
	//
	// This member is required.
	Percentage int32

	// The unique identifier for the next activity to perform, after performing the
	// holdout activity.
	NextActivity *string

	noSmithyDocumentSerde
}

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

	// 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.
	//
	// This member is required.
	Format Format

	// 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.
	//
	// This member is required.
	RoleArn *string

	// The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains
	// the endpoint definitions to import. This location can be a folder or a single
	// file. If the location is a folder, Amazon Pinpoint imports endpoint definitions
	// from the files in this location, including any subfolders that the folder
	// contains. The URL should be in the following format:
	// s3://bucket-name/folder-name/file-name. The location can end with the key for an
	// individual object or a prefix that qualifies multiple objects.
	//
	// This member is required.
	S3Url *string

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

	// (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.
	ExternalId *string

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

	// 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.
	SegmentId *string

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

	noSmithyDocumentSerde
}

// Provides information about the resource settings for a job that imports
// endpoint definitions from one or more files. The files can be stored in an
// Amazon Simple Storage Service (Amazon S3) bucket or uploaded directly from a
// computer by using the Amazon Pinpoint console.
type ImportJobResource struct {

	// 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.
	//
	// This member is required.
	Format Format

	// 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.
	//
	// This member is required.
	RoleArn *string

	// The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains
	// the endpoint definitions to import. This location can be a folder or a single
	// file. If the location is a folder, Amazon Pinpoint imports endpoint definitions
	// from the files in this location, including any subfolders that the folder
	// contains. The URL should be in the following format:
	// s3://bucket-name/folder-name/file-name. The location can end with the key for an
	// individual object or a prefix that qualifies multiple objects.
	//
	// This member is required.
	S3Url *string

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

	// (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.
	ExternalId *string

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

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

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

	noSmithyDocumentSerde
}

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

	// The unique identifier for the application that's associated with the import job.
	//
	// This member is required.
	ApplicationId *string

	// The date, in ISO 8601 format, when the import job was created.
	//
	// This member is required.
	CreationDate *string

	// The resource settings that apply to the import job.
	//
	// This member is required.
	Definition *ImportJobResource

	// The unique identifier for the import job.
	//
	// This member is required.
	Id *string

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

	// The job type. This value is IMPORT for import jobs.
	//
	// This member is required.
	Type *string

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

	// The date, in ISO 8601 format, when the import job was completed.
	CompletionDate *string

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

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

	// 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.
	TotalFailures int32

	// 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.
	TotalPieces int32

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

	noSmithyDocumentSerde
}

// Provides information about the status and settings of all the import jobs that
// are associated with an application or segment. An import job is a job that
// imports endpoint definitions from one or more files.
type ImportJobsResponse struct {

	// An array of responses, one for each import job that's associated with the
	// application (Import Jobs resource) or segment (Segment Import Jobs resource).
	//
	// This member is required.
	Item []ImportJobResponse

	// 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.
	NextToken *string

	noSmithyDocumentSerde
}

// Schedule of the campaign.
type InAppCampaignSchedule struct {

	// The scheduled time after which the in-app message should not be shown.
	// Timestamp is in ISO 8601 format.
	EndDate *string

	// The event filter the SDK has to use to show the in-app message in the
	// application.
	EventFilter *CampaignEventFilter

	// Time during which the in-app message should not be shown to the user.
	QuietTime *QuietTime

	noSmithyDocumentSerde
}

// Provides all fields required for building an in-app message.
type InAppMessage struct {

	// In-app message content.
	Content []InAppMessageContent

	// Custom config to be sent to SDK.
	CustomConfig map[string]string

	// The layout of the message.
	Layout Layout

	noSmithyDocumentSerde
}

// Text config for Message Body.
type InAppMessageBodyConfig struct {

	// The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
	//
	// This member is required.
	Alignment Alignment

	// Message Body.
	//
	// This member is required.
	Body *string

	// The text color.
	//
	// This member is required.
	TextColor *string

	noSmithyDocumentSerde
}

// Button Config for an in-app message.
type InAppMessageButton struct {

	// Default button content.
	Android *OverrideButtonConfiguration

	// Default button content.
	DefaultConfig *DefaultButtonConfiguration

	// Default button content.
	IOS *OverrideButtonConfiguration

	// Default button content.
	Web *OverrideButtonConfiguration

	noSmithyDocumentSerde
}

// Targeted in-app message campaign.
type InAppMessageCampaign struct {

	// Campaign id of the corresponding campaign.
	CampaignId *string

	// Daily cap which controls the number of times any in-app messages can be shown
	// to the endpoint during a day.
	DailyCap int32

	// In-app message content with all fields required for rendering an in-app message.
	InAppMessage *InAppMessage

	// Priority of the in-app message.
	Priority int32

	// Schedule of the campaign.
	Schedule *InAppCampaignSchedule

	// Session cap which controls the number of times an in-app message can be shown
	// to the endpoint during an application session.
	SessionCap int32

	// Total cap which controls the number of times an in-app message can be shown to
	// the endpoint.
	TotalCap int32

	// Treatment id of the campaign.
	TreatmentId *string

	noSmithyDocumentSerde
}

// The configuration for the message content.
type InAppMessageContent struct {

	// The background color for the message.
	BackgroundColor *string

	// The configuration for the message body.
	BodyConfig *InAppMessageBodyConfig

	// The configuration for the message header.
	HeaderConfig *InAppMessageHeaderConfig

	// The image url for the background of message.
	ImageUrl *string

	// The first button inside the message.
	PrimaryBtn *InAppMessageButton

	// The second button inside message.
	SecondaryBtn *InAppMessageButton

	noSmithyDocumentSerde
}

// Text config for Message Header.
type InAppMessageHeaderConfig struct {

	// The alignment of the text. Valid values: LEFT, CENTER, RIGHT.
	//
	// This member is required.
	Alignment Alignment

	// Message Header.
	//
	// This member is required.
	Header *string

	// The text color.
	//
	// This member is required.
	TextColor *string

	noSmithyDocumentSerde
}

// Get in-app messages response object.
type InAppMessagesResponse struct {

	// List of targeted in-app message campaigns.
	InAppMessageCampaigns []InAppMessageCampaign

	noSmithyDocumentSerde
}

// InApp Template Request.
type InAppTemplateRequest struct {

	// 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.
	Content []InAppMessageContent

	// Custom config to be sent to client.
	CustomConfig map[string]string

	// The layout of the message.
	Layout Layout

	// 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 (https://docs.aws.amazon.com/pinpoint/latest/apireference/tags-resource-arn.html)
	// in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi (https://docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/index.html)
	// commands in the AWS Command Line Interface Documentation or
	// resourcegroupstaggingapi (https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/resourcegroupstaggingapi/package-summary.html)
	// 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.
	Tags map[string]string

	// The description of the template.
	TemplateDescription *string

	noSmithyDocumentSerde
}

// In-App Template Response.
type InAppTemplateResponse struct {

	// The creation date of the template.
	//
	// This member is required.
	CreationDate *string

	// The last modified date of the template.
	//
	// This member is required.
	LastModifiedDate *string

	// The name of the template.
	//
	// This member is required.
	TemplateName *string

	// The type of the template.
	//
	// This member is required.
	TemplateType TemplateType

	// The resource arn of the template.
	Arn *string

	// 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.
	Content []InAppMessageContent

	// Custom config to be sent to client.
	CustomConfig map[string]string

	// The layout of the message.
	Layout Layout

	// 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.
	Tags map[string]string

	// The description of the template.
	TemplateDescription *string

	// The version id of the template.
	Version *string

	noSmithyDocumentSerde
}

// Provides information about the results of a request to create or update an
// endpoint that's associated with an event.
type ItemResponse struct {

	// The response that was received after the endpoint data was accepted.
	EndpointItemResponse *EndpointItemResponse

	// 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.
	EventsItemResponse map[string]EventItemResponse

	noSmithyDocumentSerde
}

// The channel-specific configurations for the journey.
type JourneyChannelSettings struct {

	// Amazon Resource Name (ARN) of the Connect Campaign.
	ConnectCampaignArn *string

	// IAM role ARN to be assumed when invoking Connect campaign execution APIs for
	// dialing.
	ConnectCampaignExecutionRoleArn *string

	noSmithyDocumentSerde
}

// Specifies the message content for a custom channel message that's sent to
// participants in a journey.
type JourneyCustomMessage struct {

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

	noSmithyDocumentSerde
}

// Provides the results of a query that retrieved the data for a standard
// engagement metric that applies to a journey, and provides information about that
// query.
type JourneyDateRangeKpiResponse struct {

	// The unique identifier for the application that the metric applies to.
	//
	// This member is required.
	ApplicationId *string

	// 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.
	//
	// This member is required.
	EndTime *time.Time

	// The unique identifier for the journey that the metric applies to.
	//
	// This member is required.
	JourneyId *string

	// 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 (https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html)
	// .
	//
	// This member is required.
	KpiName *string

	// An array of objects that contains the results of the query. Each object
	// contains the value for the metric and metadata about that value.
	//
	// This member is required.
	KpiResult *BaseKpiResult

	// 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.
	//
	// This member is required.
	StartTime *time.Time

	// 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.
	NextToken *string

	noSmithyDocumentSerde
}

// Specifies the "From" address for an email message that's sent to participants
// in a journey.
type JourneyEmailMessage struct {

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

	noSmithyDocumentSerde
}

// Provides the results of a query that retrieved the data for a standard
// execution metric that applies to a journey activity, and provides information
// about that query.
type JourneyExecutionActivityMetricsResponse struct {

	// 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.
	//
	// This member is required.
	ActivityType *string

	// The unique identifier for the application that the metric applies to.
	//
	// This member is required.
	ApplicationId *string

	// The unique identifier for the activity that the metric applies to.
	//
	// This member is required.
	JourneyActivityId *string

	// The unique identifier for the journey that the metric applies to.
	//
	// This member is required.
	JourneyId *string

	// 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.
	//
	// This member is required.
	LastEvaluatedTime *string

	// 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 (https://docs.aws.amazon.com/pinpoint/latest/developerguide/analytics-standard-metrics.html)
	// .
	//
	// This member is required.
	Metrics map[string]string

	noSmithyDocumentSerde
}

// Provides the results of a query that retrieved the data for a standard
// execution metric that applies to a journey, and provides information about that
// query.
type JourneyExecutionMetricsResponse struct {

	// The unique identifier for the application that the metric applies to.
	//
	// This member is required.
	ApplicationId *string

	// The unique identifier for the journey that the metric applies to.
	//
	// This member is required.
	JourneyId *string

	// The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the
	// journey and updated the data for the metric.
	//
	// This member is required.
	LastEvaluatedTime *string

	// 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 (https://docs.aws.amazon.com//pinpoint/latest/developerguide/analytics-standard-metrics.html)
	// .
	//
	// This member is required.
	Metrics map[string]string

	noSmithyDocumentSerde
}

// Specifies limits on the messages that a journey can send and the number of
// times participants can enter a journey.
type JourneyLimits struct {

	// The maximum number of messages that the journey can send to a single
	// participant during a 24-hour period. The maximum value is 100.
	DailyCap int32

	// 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.
	EndpointReentryCap int32

	// 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.
	EndpointReentryInterval *string

	// The maximum number of messages that the journey can send each second.
	MessagesPerSecond int32

	// The number of messages that an endpoint can receive during the specified
	// timeframe.
	TimeframeCap *JourneyTimeframeCap

	// 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.
	TotalCap int32

	noSmithyDocumentSerde
}

// Specifies the message configuration for a push notification that's sent to
// participants in a journey.
type JourneyPushMessage struct {

	// 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.
	TimeToLive *string

	noSmithyDocumentSerde
}

// Provides information about the status, configuration, and other settings for a
// journey.
type JourneyResponse struct {

	// The unique identifier for the application that the journey applies to.
	//
	// This member is required.
	ApplicationId *string

	// The unique identifier for the journey.
	//
	// This member is required.
	Id *string

	// The name of the journey.
	//
	// This member is required.
	Name *string

	// 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.
	Activities map[string]Activity

	// The time when a journey will not send messages. QuietTime should be configured
	// first and SendingSchedule should be set to true.
	ClosedDays *ClosedDays

	// The date, in ISO 8601 format, when the journey was created.
	CreationDate *string

	// The channel-specific configurations for the journey.
	JourneyChannelSettings *JourneyChannelSettings

	// The date, in ISO 8601 format, when the journey was last modified.
	LastModifiedDate *string

	// The messaging and entry limits for the journey.
	Limits *JourneyLimits

	// 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.
	LocalTime bool

	// The time when a journey can send messages. QuietTime should be configured first
	// and SendingSchedule should be set to true.
	OpenHours *OpenHours

	// 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.
	QuietTime *QuietTime

	// The frequency with which Amazon Pinpoint evaluates segment and event data for
	// the journey, as a duration in ISO 8601 format.
	RefreshFrequency *string

	// Indicates whether the journey participants should be refreshed when a segment
	// is updated.
	RefreshOnSegmentUpdate bool

	// The schedule settings for the journey.
	Schedule *JourneySchedule

	// Indicates if journey has Advance Quiet Time enabled. This flag should be set to
	// true in order to allow using OpenHours and ClosedDays.
	SendingSchedule bool

	// The unique identifier for the first activity in the journey.
	StartActivity *string

	// The segment that defines which users are participants in the journey.
	StartCondition *StartCondition

	// 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.
	State State

	// This object is not used or supported.
	Tags map[string]string

	// An array of time zone estimation methods, if any, to use for determining an
	// Endpoints (https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-endpoints-endpoint-id.html)
	// 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.
	TimezoneEstimationMethods []TimezoneEstimationMethodsElement

	// Indicates whether endpoints in quiet hours should enter a wait activity until
	// quiet hours have elapsed.
	WaitForQuietTime bool

	noSmithyDocumentSerde
}

// Provides the results of a query that retrieved the data for a standard
// execution metric that applies to a journey activity for a particular journey
// run, and provides information about that query.
type JourneyRunExecutionActivityMetricsResponse struct {

	// 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.
	//
	// This member is required.
	ActivityType *string

	// The unique identifier for the application that the metric applies to.
	//
	// This member is required.
	ApplicationId *string

	// The unique identifier for the activity that the metric applies to.
	//
	// This member is required.
	JourneyActivityId *string

	// The unique identifier for the journey that the metric applies to.
	//
	// This member is required.
	JourneyId *string

	// 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.
	//
	// This member is required.
	LastEvaluatedTime *string

	// 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 (https://docs.aws.amazon.com//pinpoint/latest/developerguide/analytics-standard-metrics.html)
	// in the Amazon Pinpoint Developer Guide.
	//
	// This member is required.
	Metrics map[string]string

	// The unique identifier for the journey run that the metric applies to.
	//
	// This member is required.
	RunId *string

	noSmithyDocumentSerde
}

// Provides the results of a query that retrieved the data for a standard
// execution metric that applies to a journey run, and provides information about
// that query.
type JourneyRunExecutionMetricsResponse struct {

	// The unique identifier for the application that the metric applies to.
	//
	// This member is required.
	ApplicationId *string

	// The unique identifier for the journey that the metric applies to.
	//
	// This member is required.
	JourneyId *string

	// The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the
	// journey run and updated the data for the metric.
	//
	// This member is required.
	LastEvaluatedTime *string

	// 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 (https://docs.aws.amazon.com//pinpoint/latest/developerguide/analytics-standard-metrics.html)
	// in the Amazon Pinpoint Developer Guide.
	//
	// This member is required.
	Metrics map[string]string

	// The unique identifier for the journey run that the metric applies to.
	//
	// This member is required.
	RunId *string

	noSmithyDocumentSerde
}

// Provides information from a specified run of a journey.
type JourneyRunResponse struct {

	// The time when the journey run was created or scheduled, in ISO 8601 format.
	//
	// This member is required.
	CreationTime *string

	// The last time the journey run was updated, in ISO 8601 format..
	//
	// This member is required.
	LastUpdateTime *string

	// The unique identifier for the run.
	//
	// This member is required.
	RunId *string

	// The current status of the journey run.
	//
	// This member is required.
	Status JourneyRunStatus

	noSmithyDocumentSerde
}

// Provides information from all runs of a journey.
type JourneyRunsResponse struct {

	// An array of responses, one for each run of the journey
	//
	// This member is required.
	Item []JourneyRunResponse

	// 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.
	NextToken *string

	noSmithyDocumentSerde
}

// Specifies the schedule settings for a journey.
type JourneySchedule struct {

	// The scheduled time, in ISO 8601 format, when the journey ended or will end.
	EndTime *time.Time

	// The scheduled time, in ISO 8601 format, when the journey began or will begin.
	StartTime *time.Time

	// 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.
	Timezone *string

	noSmithyDocumentSerde
}

// Specifies the sender ID and message type for an SMS message that's sent to
// participants in a journey.
type JourneySMSMessage struct {

	// The entity ID or Principal Entity (PE) id received from the regulatory body for
	// sending SMS in your country.
	EntityId *string

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

	// 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.
	OriginationNumber *string

	// The sender ID to display as the sender of the message on a recipient's device.
	// Support for sender IDs varies by country or region. For more information, see
	// Supported Countries and Regions (https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-countries.html)
	// in the Amazon Pinpoint User Guide.
	SenderId *string

	// The template ID received from the regulatory body for sending SMS in your
	// country.
	TemplateId *string

	noSmithyDocumentSerde
}

// Provides information about the status, configuration, and other settings for
// all the journeys that are associated with an application.
type JourneysResponse struct {

	// An array of responses, one for each journey that's associated with the
	// application.
	//
	// This member is required.
	Item []JourneyResponse

	// 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.
	NextToken *string

	noSmithyDocumentSerde
}

// Changes the status of a journey.
type JourneyStateRequest struct {

	// 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.
	State State

	noSmithyDocumentSerde
}

// The number of messages that can be sent to an endpoint during the specified
// timeframe for all journeys.
type JourneyTimeframeCap struct {

	// 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.
	Cap int32

	// The length of the timeframe in days. The maximum value is 30. If set to 0, this
	// limit will not apply.
	Days int32

	noSmithyDocumentSerde
}

// Provides information about all the recommender model configurations that are
// associated with your Amazon Pinpoint account.
type ListRecommenderConfigurationsResponse struct {

	// An array of responses, one for each recommender model configuration that's
	// associated with your Amazon Pinpoint account.
	//
	// This member is required.
	Item []RecommenderConfigurationResponse

	// 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.
	NextToken *string

	noSmithyDocumentSerde
}

// Specifies the content and settings for a push notification that's sent to
// recipients of a campaign.
type Message struct {

	// 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.
	Action Action

	// The body of the notification message. The maximum number of characters is 200.
	Body *string

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

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

	// The URL of an image to display in the push notification.
	ImageUrl *string

	// The JSON payload to use for a silent push notification.
	JsonBody *string

	// The URL of the image or video to display in the push notification.
	MediaUrl *string

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

	// 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.
	SilentPush bool

	// 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.
	TimeToLive int32

	// The title to display above the notification message on a recipient's device.
	Title *string

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

	noSmithyDocumentSerde
}

// Provides information about an API request or response.
type MessageBody struct {

	// The message that's returned from the API.
	Message *string

	// The unique identifier for the request or response.
	RequestID *string

	noSmithyDocumentSerde
}

// Specifies the message configuration settings for a campaign.
type MessageConfiguration struct {

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

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

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

	// 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.
	CustomMessage *CampaignCustomMessage

	// The default message that the campaign sends through all the channels that are
	// configured for the campaign.
	DefaultMessage *Message

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

	// 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.
	GCMMessage *Message

	// The in-app message configuration.
	InAppMessage *CampaignInAppMessage

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

	noSmithyDocumentSerde
}

// Specifies the configuration and other settings for a message.
type MessageRequest struct {

	// The settings and content for the default message and any default messages that
	// you defined for specific channels.
	//
	// This member is required.
	MessageConfiguration *DirectMessageConfiguration

	// A map of key-value pairs, where each key is an address and each value is an
	// AddressConfiguration (https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-addressconfiguration)
	// object. An address can be a push notification token, a phone number, or an email
	// address. You can use an AddressConfiguration (https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-addressconfiguration)
	// object to tailor the message for an address by specifying settings such as
	// content overrides and message variables.
	Addresses map[string]AddressConfiguration

	// 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.
	Context map[string]string

	// A map of key-value pairs, where each key is an endpoint ID and each value is an
	// EndpointSendConfiguration (https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-endpointsendconfiguration)
	// object. You can use an EndpointSendConfiguration (https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-endpointsendconfiguration)
	// object to tailor the message for an endpoint by specifying settings such as
	// content overrides and message variables.
	Endpoints map[string]EndpointSendConfiguration

	// The message template to use for the message.
	TemplateConfiguration *TemplateConfiguration

	// The unique identifier for tracing the message. This identifier is visible to
	// message recipients.
	TraceId *string

	noSmithyDocumentSerde
}

// Provides information about the results of a request to send a message to an
// endpoint address.
type MessageResponse struct {

	// The unique identifier for the application that was used to send the message.
	//
	// This member is required.
	ApplicationId *string

	// 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.
	EndpointResult map[string]EndpointMessageResult

	// The identifier for the original request that the message was delivered for.
	RequestId *string

	// 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.
	Result map[string]MessageResult

	noSmithyDocumentSerde
}

// Provides information about the results of sending a message directly to an
// endpoint address.
type MessageResult struct {

	// 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.
	//   - TIMEOUT - The message couldn't be sent within the timeout period.
	//   - UNKNOWN_FAILURE - An unknown error occurred.
	//
	// This member is required.
	DeliveryStatus DeliveryStatus

	// The downstream service status code for delivering the message.
	//
	// This member is required.
	StatusCode int32

	// The unique identifier for the message that was sent.
	MessageId *string

	// The status message for delivering the message.
	StatusMessage *string

	// 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.
	UpdatedToken *string

	noSmithyDocumentSerde
}

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

	// The operator to use when comparing metric values. Valid values are:
	// GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
	//
	// This member is required.
	ComparisonOperator *string

	// The value to compare.
	//
	// This member is required.
	Value float64

	noSmithyDocumentSerde
}

// Specifies a condition to evaluate for an activity path in a journey.
type MultiConditionalBranch struct {

	// The condition to evaluate for the activity path.
	Condition *SimpleCondition

	// The unique identifier for the next activity to perform, after completing the
	// activity for the path.
	NextActivity *string

	noSmithyDocumentSerde
}

// Specifies the settings for a multivariate split activity in a journey. 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. To
// create multivariate split activities that send participants down different paths
// based on push notification events (such as Open or Received events), your mobile
// app has to specify the User ID and Endpoint ID values. For more information, see
// Integrating Amazon Pinpoint with your application (https://docs.aws.amazon.com/pinpoint/latest/developerguide/integrate.html)
// in the Amazon Pinpoint Developer Guide.
type MultiConditionalSplitActivity struct {

	// The paths for the activity, including the conditions for entering each path and
	// the activity to perform for each path.
	Branches []MultiConditionalBranch

	// 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.
	DefaultActivity *string

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

	noSmithyDocumentSerde
}

// Specifies a phone number to validate and retrieve information about.
type NumberValidateRequest struct {

	// The two-character code, in ISO 3166-1 alpha-2 format, for the country or region
	// where the phone number was originally registered.
	IsoCountryCode *string

	// 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.
	PhoneNumber *string

	noSmithyDocumentSerde
}

// Provides information about a phone number.
type NumberValidateResponse struct {

	// 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.
	Carrier *string

	// The name of the city where the phone number was originally registered.
	City *string

	// The cleansed phone number, in E.164 format, for the location where the phone
	// number was originally registered.
	CleansedPhoneNumberE164 *string

	// The cleansed phone number, in the format for the location where the phone
	// number was originally registered.
	CleansedPhoneNumberNational *string

	// The name of the country or region where the phone number was originally
	// registered.
	Country *string

	// The two-character code, in ISO 3166-1 alpha-2 format, for the country or region
	// where the phone number was originally registered.
	CountryCodeIso2 *string

	// The numeric code for the country or region where the phone number was
	// originally registered.
	CountryCodeNumeric *string

	// The name of the county where the phone number was originally registered.
	County *string

	// The two-character code, in ISO 3166-1 alpha-2 format, that was sent in the
	// request body.
	OriginalCountryCodeIso2 *string

	// The phone number that was sent in the request body.
	OriginalPhoneNumber *string

	// The description of the phone type. Valid values are: MOBILE, LANDLINE, VOIP,
	// INVALID, PREPAID, and OTHER.
	PhoneType *string

	// The phone type, represented by an integer. Valid values are: 0 (mobile), 1
	// (landline), 2 (VoIP), 3 (invalid), 4 (other), and 5 (prepaid).
	PhoneTypeCode int32

	// The time zone for the location where the phone number was originally registered.
	Timezone *string

	// The postal or ZIP code for the location where the phone number was originally
	// registered.
	ZipCode *string

	noSmithyDocumentSerde
}

// Specifies the times when message are allowed to be sent to endpoints.
type OpenHours struct {

	// Specifies the schedule settings for the custom channel.
	CUSTOM map[string][]OpenHoursRule

	// Specifies the schedule settings for the email channel.
	EMAIL map[string][]OpenHoursRule

	// Specifies the schedule settings for the push channel.
	PUSH map[string][]OpenHoursRule

	// Specifies the schedule settings for the SMS channel.
	SMS map[string][]OpenHoursRule

	// Specifies the schedule settings for the voice channel.
	VOICE map[string][]OpenHoursRule

	noSmithyDocumentSerde
}

// Specifies the start and end time for OpenHours.
type OpenHoursRule struct {

	// The end of the scheduled time, in ISO 8601 format, when the channel can't send
	// messages.
	EndTime *string

	// The start of the scheduled time, in ISO 8601 format, when the channel can send
	// messages.
	StartTime *string

	noSmithyDocumentSerde
}

// Override button configuration.
type OverrideButtonConfiguration struct {

	// Action triggered by the button.
	//
	// This member is required.
	ButtonAction ButtonAction

	// Button destination.
	Link *string

	noSmithyDocumentSerde
}

// Specifies the properties and attributes of an endpoint that's associated with
// an event.
type PublicEndpoint struct {

	// The unique identifier for the recipient, such as a device token, email address,
	// or mobile phone number.
	Address *string

	// 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.
	Attributes map[string][]string

	// The channel that's used when sending messages or push notifications to the
	// endpoint.
	ChannelType ChannelType

	// The demographic information for the endpoint, such as the time zone and
	// platform.
	Demographic *EndpointDemographic

	// The date and time, in ISO 8601 format, when the endpoint was last updated.
	EffectiveDate *string

	// 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.
	EndpointStatus *string

	// The geographic information for the endpoint.
	Location *EndpointLocation

	// One or more custom metrics that your app reports to Amazon Pinpoint for the
	// endpoint.
	Metrics map[string]float64

	// 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.
	OptOut *string

	// A unique identifier that's generated each time the endpoint is updated.
	RequestId *string

	// One or more custom user attributes that your app reports to Amazon Pinpoint for
	// the user who's associated with the endpoint.
	User *EndpointUser

	noSmithyDocumentSerde
}

// Specifies the settings for a push notification activity in a journey. This type
// of activity sends a push notification to participants.
type PushMessageActivity struct {

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

	// The unique identifier for the next activity to perform, after the message is
	// sent.
	NextActivity *string

	// The name of the push notification template to use for the message. If
	// specified, this value must match the name of an existing message template.
	TemplateName *string

	// The unique identifier for the version of the push notification template to use
	// for the message. If specified, this value must match the identifier for an
	// existing template version. To retrieve a list of versions and version
	// identifiers for a template, use the Template 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.
	TemplateVersion *string

	noSmithyDocumentSerde
}

// Specifies the content and settings for a message template that can be used in
// messages that are sent through a push notification channel.
type PushNotificationTemplateRequest struct {

	// The message template to use for the ADM (Amazon Device Messaging) channel. This
	// message template overrides the default template for push notification channels
	// (DefaultPushNotificationTemplate).
	ADM *AndroidPushNotificationTemplate

	// 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).
	APNS *APNSPushNotificationTemplate

	// The message template to use for the Baidu (Baidu Cloud Push) channel. This
	// message template overrides the default template for push notification channels
	// (DefaultPushNotificationTemplate).
	Baidu *AndroidPushNotificationTemplate

	// The default message template to use for push notification channels.
	Default *DefaultPushNotificationTemplate

	// 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.
	DefaultSubstitutions *string

	// 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).
	GCM *AndroidPushNotificationTemplate

	// 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.
	RecommenderId *string

	// As of 22-05-2023 tags has been deprecated for update operations. After this
	// date any value in tags is not processed and an error code is not returned. To
	// manage tags we recommend using either Tags (https://docs.aws.amazon.com/pinpoint/latest/apireference/tags-resource-arn.html)
	// in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi (https://docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/index.html)
	// commands in the AWS Command Line Interface Documentation or
	// resourcegroupstaggingapi (https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/resourcegroupstaggingapi/package-summary.html)
	// 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.
	Tags map[string]string

	// A custom description of the message template.
	TemplateDescription *string

	noSmithyDocumentSerde
}

// Provides information about the content and settings for a message template that
// can be used in messages that are sent through a push notification channel.
type PushNotificationTemplateResponse struct {

	// The date, in ISO 8601 format, when the message template was created.
	//
	// This member is required.
	CreationDate *string

	// The date, in ISO 8601 format, when the message template was last modified.
	//
	// This member is required.
	LastModifiedDate *string

	// The name of the message template.
	//
	// This member is required.
	TemplateName *string

	// The type of channel that the message template is designed for. For a push
	// notification template, this value is PUSH.
	//
	// This member is required.
	TemplateType TemplateType

	// 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).
	ADM *AndroidPushNotificationTemplate

	// 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).
	APNS *APNSPushNotificationTemplate

	// The Amazon Resource Name (ARN) of the message template.
	Arn *string

	// 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).
	Baidu *AndroidPushNotificationTemplate

	// The default message template that's used for push notification channels.
	Default *DefaultPushNotificationTemplate

	// 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.
	DefaultSubstitutions *string

	// 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).
	GCM *AndroidPushNotificationTemplate

	// The unique identifier for the recommender model that's used by the message
	// template.
	RecommenderId *string

	// 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.
	Tags map[string]string

	// The custom description of the message template.
	TemplateDescription *string

	// 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.
	Version *string

	noSmithyDocumentSerde
}

// Specifies the start and end times that define a time range when messages aren't
// sent to endpoints.
type QuietTime struct {

	// 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.
	End *string

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

	noSmithyDocumentSerde
}

// Specifies the settings for a random split activity in a journey. 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.
type RandomSplitActivity struct {

	// The paths for the activity, including the percentage of participants to enter
	// each path and the activity to perform for each path.
	Branches []RandomSplitEntry

	noSmithyDocumentSerde
}

// Specifies the settings for a path in a random split activity in a journey.
type RandomSplitEntry struct {

	// The unique identifier for the next activity to perform, after completing the
	// activity for the path.
	NextActivity *string

	// 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.
	Percentage int32

	noSmithyDocumentSerde
}

// Specifies the contents of an email message, represented as a raw MIME message.
type RawEmail struct {

	// The email message, represented as a raw MIME message. The entire message must
	// be base64 encoded.
	Data []byte

	noSmithyDocumentSerde
}

// Specifies criteria for including or excluding endpoints from a segment based on
// how recently an endpoint was active.
type RecencyDimension struct {

	// The duration to use when determining whether an endpoint is active or inactive.
	//
	// This member is required.
	Duration Duration

	// 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.
	//
	// This member is required.
	RecencyType RecencyType

	noSmithyDocumentSerde
}

// Provides information about Amazon Pinpoint configuration settings for
// retrieving and processing data from a recommender model.
type RecommenderConfigurationResponse struct {

	// The date, in extended ISO 8601 format, when the configuration was created for
	// the recommender model.
	//
	// This member is required.
	CreationDate *string

	// The unique identifier for the recommender model configuration.
	//
	// This member is required.
	Id *string

	// The date, in extended ISO 8601 format, when the configuration for the
	// recommender model was last modified.
	//
	// This member is required.
	LastModifiedDate *string

	// The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM)
	// role that authorizes Amazon Pinpoint to retrieve recommendation data from the
	// recommender model.
	//
	// This member is required.
	RecommendationProviderRoleArn *string

	// The Amazon Resource Name (ARN) of the recommender model that Amazon Pinpoint
	// retrieves the recommendation data from. This value is the ARN of an Amazon
	// Personalize campaign.
	//
	// This member is required.
	RecommendationProviderUri *string

	// 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.
	Attributes map[string]string

	// The custom description of the configuration for the recommender model.
	Description *string

	// The custom name of the configuration for the recommender model.
	Name *string

	// The type of Amazon Pinpoint ID that's associated with unique user IDs in the
	// recommender model. This value enables the model to use attribute and event data
	// that’s specific to a particular endpoint or user in an Amazon Pinpoint
	// application. Possible values are:
	//   - PINPOINT_ENDPOINT_ID - Each user in the model is associated with a
	//   particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint
	//   IDs in Amazon Pinpoint. This is the default value.
	//   - PINPOINT_USER_ID - Each user in the model is associated with a particular
	//   user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs
	//   in Amazon Pinpoint. If this value is specified, an endpoint definition in Amazon
	//   Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise,
	//   messages won’t be sent to the user's endpoint.
	RecommendationProviderIdType *string

	// The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon
	// Pinpoint invokes to perform additional processing of recommendation data that it
	// retrieves from the recommender model.
	RecommendationTransformerUri *string

	// The custom display name for the standard endpoint or user attribute
	// (RecommendationItems) that temporarily stores recommended items for each
	// endpoint or user, depending on the value for the RecommendationProviderIdType
	// property. This name appears in the Attribute finder of the template editor on
	// the Amazon Pinpoint console. This value is null if the configuration doesn't
	// invoke an AWS Lambda function (RecommendationTransformerUri) to perform
	// additional processing of recommendation data.
	RecommendationsDisplayName *string

	// 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.
	RecommendationsPerMessage int32

	noSmithyDocumentSerde
}

// Provides the results of a query that retrieved the data for a standard metric
// that applies to an application, campaign, or journey.
type ResultRow struct {

	// 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.
	//
	// This member is required.
	GroupedBys []ResultRowValue

	// An array of objects that provides pre-aggregated values for a standard metric
	// that applies to an application, campaign, or journey.
	//
	// This member is required.
	Values []ResultRowValue

	noSmithyDocumentSerde
}

// Provides a single value and metadata about that value as part of an array of
// query results for a standard metric that applies to an application, campaign, or
// journey.
type ResultRowValue struct {

	// The friendly name of the metric whose value is specified by the Value property.
	//
	// This member is required.
	Key *string

	// The data type of the value specified by the Value property.
	//
	// This member is required.
	Type *string

	// 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).
	//
	// This member is required.
	Value *string

	noSmithyDocumentSerde
}

// Specifies the schedule settings for a campaign.
type Schedule struct {

	// 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.
	//
	// This member is required.
	StartTime *string

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

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

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

	// 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.
	IsLocalTime bool

	// 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.
	QuietTime *QuietTime

	// 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.
	Timezone *string

	noSmithyDocumentSerde
}

// Specifies dimension settings for including or excluding endpoints from a
// segment based on how recently an endpoint was active.
type SegmentBehaviors struct {

	// The dimension settings that are based on how recently an endpoint was active.
	Recency *RecencyDimension

	noSmithyDocumentSerde
}

// Specifies a segment to associate with an activity in a journey.
type SegmentCondition struct {

	// The unique identifier for the segment to associate with the activity.
	//
	// This member is required.
	SegmentId *string

	noSmithyDocumentSerde
}

// Specifies demographic-based dimension settings for including or excluding
// endpoints from a segment. These settings derive from characteristics of endpoint
// devices, such as platform, make, and model.
type SegmentDemographics struct {

	// The app version criteria for the segment.
	AppVersion *SetDimension

	// The channel criteria for the segment.
	Channel *SetDimension

	// The device type criteria for the segment.
	DeviceType *SetDimension

	// The device make criteria for the segment.
	Make *SetDimension

	// The device model criteria for the segment.
	Model *SetDimension

	// The device platform criteria for the segment.
	Platform *SetDimension

	noSmithyDocumentSerde
}

// Specifies the dimension settings for a segment.
type SegmentDimensions struct {

	// One or more custom attributes to use as criteria for the segment.
	Attributes map[string]AttributeDimension

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

	// The demographic-based criteria, such as device platform, for the segment.
	Demographic *SegmentDemographics

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

	// One or more custom metrics to use as criteria for the segment.
	Metrics map[string]MetricDimension

	// One or more custom user attributes to use as criteria for the segment.
	UserAttributes map[string]AttributeDimension

	noSmithyDocumentSerde
}

// Specifies the base segments and dimensions for a segment, and the relationships
// between these base segments and dimensions.
type SegmentGroup struct {

	// An array that defines the dimensions for the segment.
	Dimensions []SegmentDimensions

	// 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.
	SourceSegments []SegmentReference

	// 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.
	SourceType SourceType

	// 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.
	Type Type

	noSmithyDocumentSerde
}

// Specifies the settings that define the relationships between segment groups for
// a segment.
type SegmentGroupList struct {

	// An array that defines the set of segment criteria to evaluate when handling
	// segment groups for the segment.
	Groups []SegmentGroup

	// 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.
	Include Include

	noSmithyDocumentSerde
}

// Provides information about the import job that created a segment. An import job
// is a job that creates a user segment by importing endpoint definitions.
type SegmentImportResource struct {

	// (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.
	//
	// This member is required.
	ExternalId *string

	// The format of the files that were imported to create the segment. Valid values
	// are: CSV, for comma-separated values format; and, JSON, for newline-delimited
	// JSON format.
	//
	// This member is required.
	Format Format

	// 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.
	//
	// This member is required.
	RoleArn *string

	// The URL of the Amazon Simple Storage Service (Amazon S3) bucket that the
	// endpoint definitions were imported from to create the segment.
	//
	// This member is required.
	S3Url *string

	// The number of endpoint definitions that were imported successfully to create
	// the segment.
	//
	// This member is required.
	Size int32

	// The number of channel types in the endpoint definitions that were imported to
	// create the segment.
	ChannelCounts map[string]int32

	noSmithyDocumentSerde
}

// Specifies geographical dimension settings for a segment.
type SegmentLocation struct {

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

	// The GPS location and range for the segment.
	GPSPoint *GPSPointDimension

	noSmithyDocumentSerde
}

// Specifies the segment identifier and version of a segment.
type SegmentReference struct {

	// The unique identifier for the segment.
	//
	// This member is required.
	Id *string

	// The version number of the segment.
	Version int32

	noSmithyDocumentSerde
}

// Provides information about the configuration, dimension, and other settings for
// a segment.
type SegmentResponse struct {

	// The unique identifier for the application that the segment is associated with.
	//
	// This member is required.
	ApplicationId *string

	// The Amazon Resource Name (ARN) of the segment.
	//
	// This member is required.
	Arn *string

	// The date and time when the segment was created.
	//
	// This member is required.
	CreationDate *string

	// The unique identifier for the segment.
	//
	// This member is required.
	Id *string

	// The segment type. Valid values are:
	//   - DIMENSIONAL - A dynamic segment, which is a segment that uses selection
	//   criteria that you specify and is based on endpoint data that's reported by your
	//   app. Dynamic segments can change over time.
	//   - IMPORT - A static segment, which is a segment that uses selection criteria
	//   that you specify and is based on endpoint definitions that you import from a
	//   file. Imported segments are static; they don't change over time.
	//
	// This member is required.
	SegmentType SegmentType

	// The dimension settings for the segment.
	Dimensions *SegmentDimensions

	// The settings for the import job that's associated with the segment.
	ImportDefinition *SegmentImportResource

	// The date and time when the segment was last modified.
	LastModifiedDate *string

	// The name of the segment.
	Name *string

	// 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.
	SegmentGroups *SegmentGroupList

	// 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.
	Tags map[string]string

	// The version number of the segment.
	Version int32

	noSmithyDocumentSerde
}

// Provides information about all the segments that are associated with an
// application.
type SegmentsResponse struct {

	// 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).
	//
	// This member is required.
	Item []SegmentResponse

	// 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.
	NextToken *string

	noSmithyDocumentSerde
}

// Send OTP message request parameters.
type SendOTPMessageRequestParameters struct {

	// The brand name that will be substituted into the OTP message body. Should be
	// owned by calling AWS account.
	//
	// This member is required.
	BrandName *string

	// Channel type for the OTP message. Supported values: [SMS].
	//
	// This member is required.
	Channel *string

	// The destination identity to send OTP to.
	//
	// This member is required.
	DestinationIdentity *string

	// The origination identity used to send OTP from.
	//
	// This member is required.
	OriginationIdentity *string

	// Developer-specified reference identifier. Required to match during OTP
	// verification.
	//
	// This member is required.
	ReferenceId *string

	// The attempts allowed to validate an OTP.
	AllowedAttempts int32

	// The number of characters in the generated OTP.
	CodeLength int32

	// A unique Entity ID received from DLT after entity registration is approved.
	EntityId *string

	// The language to be used for the outgoing message body containing the OTP.
	Language *string

	// A unique Template ID received from DLT after entity registration is approved.
	TemplateId *string

	// The time in minutes before the OTP is no longer valid.
	ValidityPeriod int32

	noSmithyDocumentSerde
}

// Specifies the configuration and other settings for a message to send to all the
// endpoints that are associated with a list of users.
type SendUsersMessageRequest struct {

	// The settings and content for the default message and any default messages that
	// you defined for specific channels.
	//
	// This member is required.
	MessageConfiguration *DirectMessageConfiguration

	// A map that associates user IDs with EndpointSendConfiguration (https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-endpointsendconfiguration)
	// objects. You can use an EndpointSendConfiguration (https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-messages.html#apps-application-id-messages-model-endpointsendconfiguration)
	// object to tailor the message for a user by specifying settings such as content
	// overrides and message variables.
	//
	// This member is required.
	Users map[string]EndpointSendConfiguration

	// 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.
	Context map[string]string

	// The message template to use for the message.
	TemplateConfiguration *TemplateConfiguration

	// The unique identifier for tracing the message. This identifier is visible to
	// message recipients.
	TraceId *string

	noSmithyDocumentSerde
}

// Provides information about which users and endpoints a message was sent to.
type SendUsersMessageResponse struct {

	// The unique identifier for the application that was used to send the message.
	//
	// This member is required.
	ApplicationId *string

	// The unique identifier that was assigned to the message request.
	RequestId *string

	// 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.
	Result map[string]map[string]EndpointMessageResult

	noSmithyDocumentSerde
}

// Provides information about a session.
type Session struct {

	// The unique identifier for the session.
	//
	// This member is required.
	Id *string

	// The date and time when the session began.
	//
	// This member is required.
	StartTimestamp *string

	// The duration of the session, in milliseconds.
	Duration int32

	// The date and time when the session ended.
	StopTimestamp *string

	noSmithyDocumentSerde
}

// Specifies the dimension type and values for a segment dimension.
type SetDimension struct {

	// 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.
	//
	// This member is required.
	Values []string

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

	noSmithyDocumentSerde
}

// Specifies a condition to evaluate for an activity in a journey.
type SimpleCondition struct {

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

	// The segment that's associated with the activity.
	SegmentCondition *SegmentCondition

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

	noSmithyDocumentSerde
}

// Specifies the contents of an email message, composed of a subject, a text part,
// and an HTML part.
type SimpleEmail struct {

	// 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.
	HtmlPart *SimpleEmailPart

	// The subject line, or title, of the email.
	Subject *SimpleEmailPart

	// 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.
	TextPart *SimpleEmailPart

	noSmithyDocumentSerde
}

// Specifies the subject or body of an email message, represented as textual email
// data and the applicable character set.
type SimpleEmailPart struct {

	// The applicable character set for the message content.
	Charset *string

	// The textual data of the message content.
	Data *string

	noSmithyDocumentSerde
}

// Specifies the status and settings of the SMS channel for an application.
type SMSChannelRequest struct {

	// Specifies whether to enable the SMS channel for the application.
	Enabled bool

	// The identity that you want to display on recipients' devices when they receive
	// messages from the SMS channel.
	SenderId *string

	// The registered short code that you want to use when you send messages through
	// the SMS channel.
	ShortCode *string

	noSmithyDocumentSerde
}

// Provides information about the status and settings of the SMS channel for an
// application.
type SMSChannelResponse struct {

	// The type of messaging or notification platform for the channel. For the SMS
	// channel, this value is SMS.
	//
	// This member is required.
	Platform *string

	// The unique identifier for the application that the SMS channel applies to.
	ApplicationId *string

	// The date and time, in ISO 8601 format, when the SMS channel was enabled.
	CreationDate *string

	// Specifies whether the SMS channel is enabled for the application.
	Enabled bool

	// (Not used) This property is retained only for backward compatibility.
	HasCredential bool

	// (Deprecated) An identifier for the SMS channel. This property is retained only
	// for backward compatibility.
	Id *string

	// Specifies whether the SMS channel is archived.
	IsArchived bool

	// The user who last modified the SMS channel.
	LastModifiedBy *string

	// The date and time, in ISO 8601 format, when the SMS channel was last modified.
	LastModifiedDate *string

	// The maximum number of promotional messages that you can send through the SMS
	// channel each second.
	PromotionalMessagesPerSecond int32

	// The identity that displays on recipients' devices when they receive messages
	// from the SMS channel.
	SenderId *string

	// The registered short code to use when you send messages through the SMS channel.
	ShortCode *string

	// The maximum number of transactional messages that you can send through the SMS
	// channel each second.
	TransactionalMessagesPerSecond int32

	// The current version of the SMS channel.
	Version int32

	noSmithyDocumentSerde
}

// Specifies the default settings for a one-time SMS message that's sent directly
// to an endpoint.
type SMSMessage struct {

	// The body of the SMS message.
	Body *string

	// The entity ID or Principal Entity (PE) id received from the regulatory body for
	// sending SMS in your country.
	EntityId *string

	// The SMS program name that you provided to AWS Support when you requested your
	// dedicated number.
	Keyword *string

	// This field is reserved for future use.
	MediaUrl *string

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

	// 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.
	OriginationNumber *string

	// The sender ID to display as the sender of the message on a recipient's device.
	// Support for sender IDs varies by country or region.
	SenderId *string

	// The message variables to use in the SMS message. You can override the default
	// variables with individual address variables.
	Substitutions map[string][]string

	// The template ID received from the regulatory body for sending SMS in your
	// country.
	TemplateId *string

	noSmithyDocumentSerde
}

// Specifies the settings for an SMS activity in a journey. This type of activity
// sends a text message to participants.
type SMSMessageActivity struct {

	// Specifies the sender ID and message type for an SMS message that's sent to
	// participants in a journey.
	MessageConfig *JourneySMSMessage

	// The unique identifier for the next activity to perform, after the message is
	// sent.
	NextActivity *string

	// The name of the SMS message template to use for the message. If specified, this
	// value must match the name of an existing message template.
	TemplateName *string

	// The unique identifier for the version of the SMS template to use for the
	// message. If specified, this value must match the identifier for an existing
	// template version. To retrieve a list of versions and version identifiers for a
	// template, use the Template 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.
	TemplateVersion *string

	noSmithyDocumentSerde
}

// Specifies the content and settings for a message template that can be used in
// text messages that are sent through the SMS channel.
type SMSTemplateRequest struct {

	// The message body to use in text messages that are based on the message template.
	Body *string

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

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

	// As of 22-05-2023 tags has been deprecated for update operations. After this
	// date any value in tags is not processed and an error code is not returned. To
	// manage tags we recommend using either Tags (https://docs.aws.amazon.com/pinpoint/latest/apireference/tags-resource-arn.html)
	// in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi (https://docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/index.html)
	// commands in the AWS Command Line Interface Documentation or
	// resourcegroupstaggingapi (https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/resourcegroupstaggingapi/package-summary.html)
	// 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.
	Tags map[string]string

	// A custom description of the message template.
	TemplateDescription *string

	noSmithyDocumentSerde
}

// Provides information about the content and settings for a message template that
// can be used in text messages that are sent through the SMS channel.
type SMSTemplateResponse struct {

	// The date, in ISO 8601 format, when the message template was created.
	//
	// This member is required.
	CreationDate *string

	// The date, in ISO 8601 format, when the message template was last modified.
	//
	// This member is required.
	LastModifiedDate *string

	// The name of the message template.
	//
	// This member is required.
	TemplateName *string

	// The type of channel that the message template is designed for. For an SMS
	// template, this value is SMS.
	//
	// This member is required.
	TemplateType TemplateType

	// The Amazon Resource Name (ARN) of the message template.
	Arn *string

	// The message body that's used in text messages that are based on the message
	// template.
	Body *string

	// 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.
	DefaultSubstitutions *string

	// The unique identifier for the recommender model that's used by the message
	// template.
	RecommenderId *string

	// 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.
	Tags map[string]string

	// The custom description of the message template.
	TemplateDescription *string

	// 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.
	Version *string

	noSmithyDocumentSerde
}

// Specifies the conditions for the first activity in a journey. This activity and
// its conditions determine which users are participants in a journey.
type StartCondition struct {

	// The custom description of the condition.
	Description *string

	// Specifies the settings for an event that causes a journey activity to start.
	EventStartCondition *EventStartCondition

	// The segment that's associated with the first activity in the journey. This
	// segment determines which users are participants in the journey.
	SegmentStartCondition *SegmentCondition

	noSmithyDocumentSerde
}

// Specifies the tags (keys and values) for an application, campaign, message
// template, or segment.
type TagsModel struct {

	// 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.
	//
	// This member is required.
	Tags map[string]string

	noSmithyDocumentSerde
}

// Specifies the name and version of the message template to use for the message.
type Template struct {

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

	// The unique identifier for the version of the message template to use for the
	// message. If specified, this value must match the identifier for an existing
	// template version. To retrieve a list of versions and version identifiers for a
	// template, use the Template 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.
	Version *string

	noSmithyDocumentSerde
}

// Specifies which version of a message template to use as the active version of
// the template.
type TemplateActiveVersionRequest struct {

	// 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.
	Version *string

	noSmithyDocumentSerde
}

// Specifies the message template to use for the message, for each type of channel.
type TemplateConfiguration struct {

	// The email template to use for the message.
	EmailTemplate *Template

	// The InApp template to use for the message. The InApp template object is not
	// supported for SendMessages.
	InAppTemplate *Template

	// The push notification template to use for the message.
	PushTemplate *Template

	// The SMS template to use for the message.
	SMSTemplate *Template

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

	noSmithyDocumentSerde
}

// Provides information about a request to create a message template.
type TemplateCreateMessageBody struct {

	// The Amazon Resource Name (ARN) of the message template that was created.
	Arn *string

	// The message that's returned from the API for the request to create the message
	// template.
	Message *string

	// The unique identifier for the request to create the message template.
	RequestID *string

	noSmithyDocumentSerde
}

// Provides information about a message template that's associated with your
// Amazon Pinpoint account.
type TemplateResponse struct {

	// The date, in ISO 8601 format, when the message template was created.
	//
	// This member is required.
	CreationDate *string

	// The date, in ISO 8601 format, when the message template was last modified.
	//
	// This member is required.
	LastModifiedDate *string

	// The name of the message template.
	//
	// This member is required.
	TemplateName *string

	// The type of channel that the message template is designed for. Possible values
	// are: EMAIL, PUSH, SMS, INAPP, and VOICE.
	//
	// This member is required.
	TemplateType TemplateType

	// 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.
	Arn *string

	// 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.
	DefaultSubstitutions *string

	// 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.
	Tags map[string]string

	// 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.
	TemplateDescription *string

	// The unique identifier, as an integer, for the active version of the message
	// template.
	Version *string

	noSmithyDocumentSerde
}

// Provides information about all the message templates that are associated with
// your Amazon Pinpoint account.
type TemplatesResponse struct {

	// 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.
	//
	// This member is required.
	Item []TemplateResponse

	// 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.
	NextToken *string

	noSmithyDocumentSerde
}

// Provides information about a specific version of a message template.
type TemplateVersionResponse struct {

	// The date, in ISO 8601 format, when the version of the message template was
	// created.
	//
	// This member is required.
	CreationDate *string

	// The date, in ISO 8601 format, when the version of the message template was last
	// modified.
	//
	// This member is required.
	LastModifiedDate *string

	// The name of the message template.
	//
	// This member is required.
	TemplateName *string

	// The type of channel that the message template is designed for. Possible values
	// are: EMAIL, PUSH, SMS, INAPP, and VOICE.
	//
	// This member is required.
	TemplateType *string

	// 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.
	DefaultSubstitutions *string

	// The custom description of the version of the message template.
	TemplateDescription *string

	// 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.
	Version *string

	noSmithyDocumentSerde
}

// Provides information about all the versions of a specific message template.
type TemplateVersionsResponse struct {

	// An array of responses, one for each version of the message template.
	//
	// This member is required.
	Item []TemplateVersionResponse

	// The message that's returned from the API for the request to retrieve
	// information about all the versions of the message template.
	Message *string

	// 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.
	NextToken *string

	// The unique identifier for the request to retrieve information about all the
	// versions of the message template.
	RequestID *string

	noSmithyDocumentSerde
}

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

	// The unique identifier for the treatment.
	//
	// This member is required.
	Id *string

	// The allocated percentage of users (segment members) that the treatment is sent
	// to.
	//
	// This member is required.
	SizePercent int32

	// 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.
	CustomDeliveryConfiguration *CustomDeliveryConfiguration

	// The message configuration settings for the treatment.
	MessageConfiguration *MessageConfiguration

	// The schedule settings for the treatment.
	Schedule *Schedule

	// The current status of the treatment.
	State *CampaignState

	// The message template to use for the treatment.
	TemplateConfiguration *TemplateConfiguration

	// The custom description of the treatment.
	TreatmentDescription *string

	// The custom name of the treatment.
	TreatmentName *string

	noSmithyDocumentSerde
}

// Specifies one or more attributes to remove from all the endpoints that are
// associated with an application.
type UpdateAttributesRequest struct {

	// 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.
	Blacklist []string

	noSmithyDocumentSerde
}

// Specifies Amazon Pinpoint configuration settings for retrieving and processing
// recommendation data from a recommender model.
type UpdateRecommenderConfigurationShape struct {

	// 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.
	//
	// This member is required.
	RecommendationProviderRoleArn *string

	// 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.
	//
	// This member is required.
	RecommendationProviderUri *string

	// 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.
	Attributes map[string]string

	// A custom description of the configuration for the recommender model. The
	// description can contain up to 128 characters. The characters can be letters,
	// numbers, spaces, or the following symbols: _ ; () , ‐.
	Description *string

	// A custom name of the configuration for the recommender model. The name must
	// start with a letter or number and it can contain up to 128 characters. The
	// characters can be letters, numbers, spaces, underscores (_), or hyphens (-).
	Name *string

	// The type of Amazon Pinpoint ID to associate with unique user IDs in the
	// recommender model. This value enables the model to use attribute and event data
	// that’s specific to a particular endpoint or user in an Amazon Pinpoint
	// application. Valid values are:
	//   - PINPOINT_ENDPOINT_ID - Associate each user in the model with a particular
	//   endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in
	//   Amazon Pinpoint. This is the default value.
	//   - PINPOINT_USER_ID - Associate each user in the model with a particular user
	//   and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in
	//   Amazon Pinpoint. If you specify this value, an endpoint definition in Amazon
	//   Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise,
	//   messages won’t be sent to the user's endpoint.
	RecommendationProviderIdType *string

	// The name or Amazon Resource Name (ARN) of the AWS Lambda function to invoke for
	// additional processing of recommendation data that's retrieved from the
	// recommender model.
	RecommendationTransformerUri *string

	// A custom display name for the standard endpoint or user attribute
	// (RecommendationItems) that temporarily stores recommended items for each
	// endpoint or user, depending on the value for the RecommendationProviderIdType
	// property. This value is required if the configuration doesn't invoke an AWS
	// Lambda function (RecommendationTransformerUri) to perform additional processing
	// of recommendation data. This name appears in the Attribute finder of the
	// template editor on the Amazon Pinpoint console. The name can contain up to 25
	// characters. The characters can be letters, numbers, spaces, underscores (_), or
	// hyphens (-). These restrictions don't apply to attribute values.
	RecommendationsDisplayName *string

	// 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.
	RecommendationsPerMessage int32

	noSmithyDocumentSerde
}

// Verify OTP Message Response.
type VerificationResponse struct {

	// Specifies whether the OTP is valid or not.
	Valid bool

	noSmithyDocumentSerde
}

// Verify OTP message request.
type VerifyOTPMessageRequestParameters struct {

	// The destination identity to send OTP to.
	//
	// This member is required.
	DestinationIdentity *string

	// The OTP the end user provided for verification.
	//
	// This member is required.
	Otp *string

	// The reference identifier provided when the OTP was previously sent.
	//
	// This member is required.
	ReferenceId *string

	noSmithyDocumentSerde
}

// Specifies the status and settings of the voice channel for an application.
type VoiceChannelRequest struct {

	// Specifies whether to enable the voice channel for the application.
	Enabled bool

	noSmithyDocumentSerde
}

// Provides information about the status and settings of the voice channel for an
// application.
type VoiceChannelResponse struct {

	// The type of messaging or notification platform for the channel. For the voice
	// channel, this value is VOICE.
	//
	// This member is required.
	Platform *string

	// The unique identifier for the application that the voice channel applies to.
	ApplicationId *string

	// The date and time, in ISO 8601 format, when the voice channel was enabled.
	CreationDate *string

	// Specifies whether the voice channel is enabled for the application.
	Enabled bool

	// (Not used) This property is retained only for backward compatibility.
	HasCredential bool

	// (Deprecated) An identifier for the voice channel. This property is retained
	// only for backward compatibility.
	Id *string

	// Specifies whether the voice channel is archived.
	IsArchived bool

	// The user who last modified the voice channel.
	LastModifiedBy *string

	// The date and time, in ISO 8601 format, when the voice channel was last modified.
	LastModifiedDate *string

	// The current version of the voice channel.
	Version int32

	noSmithyDocumentSerde
}

// Specifies the settings for a one-time voice message that's sent directly to an
// endpoint through the voice channel.
type VoiceMessage struct {

	// The text of the script to use for the voice message.
	Body *string

	// 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 (https://docs.aws.amazon.com/polly/latest/dg/what-is.html)
	// .
	LanguageCode *string

	// 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.
	OriginationNumber *string

	// The default message variables to use in the voice message. You can override the
	// default variables with individual address variables.
	Substitutions map[string][]string

	// The name of the voice to use when delivering the message. For a list of
	// supported voices, see the Amazon Polly Developer Guide (https://docs.aws.amazon.com/polly/latest/dg/what-is.html)
	// .
	VoiceId *string

	noSmithyDocumentSerde
}

// Specifies the content and settings for a message template that can be used in
// messages that are sent through the voice channel.
type VoiceTemplateRequest struct {

	// The text of the script to use in messages that are based on the message
	// template, in plain text format.
	Body *string

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

	// The code for the language to use when synthesizing the text of the script in
	// messages that are based on the message template. For a list of supported
	// languages and the code for each one, see the Amazon Polly Developer Guide (https://docs.aws.amazon.com/polly/latest/dg/what-is.html)
	// .
	LanguageCode *string

	// As of 22-05-2023 tags has been deprecated for update operations. After this
	// date any value in tags is not processed and an error code is not returned. To
	// manage tags we recommend using either Tags (https://docs.aws.amazon.com/pinpoint/latest/apireference/tags-resource-arn.html)
	// in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi (https://docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/index.html)
	// commands in the AWS Command Line Interface Documentation or
	// resourcegroupstaggingapi (https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/resourcegroupstaggingapi/package-summary.html)
	// 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.
	Tags map[string]string

	// A custom description of the message template.
	TemplateDescription *string

	// The name of the voice to use when delivering messages that are based on the
	// message template. For a list of supported voices, see the Amazon Polly
	// Developer Guide (https://docs.aws.amazon.com/polly/latest/dg/what-is.html) .
	VoiceId *string

	noSmithyDocumentSerde
}

// Provides information about the content and settings for a message template that
// can be used in messages that are sent through the voice channel.
type VoiceTemplateResponse struct {

	// The date, in ISO 8601 format, when the message template was created.
	//
	// This member is required.
	CreationDate *string

	// The date, in ISO 8601 format, when the message template was last modified.
	//
	// This member is required.
	LastModifiedDate *string

	// The name of the message template.
	//
	// This member is required.
	TemplateName *string

	// The type of channel that the message template is designed for. For a voice
	// template, this value is VOICE.
	//
	// This member is required.
	TemplateType TemplateType

	// The Amazon Resource Name (ARN) of the message template.
	Arn *string

	// The text of the script that's used in messages that are based on the message
	// template, in plain text format.
	Body *string

	// 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.
	DefaultSubstitutions *string

	// 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 (https://docs.aws.amazon.com/polly/latest/dg/what-is.html)
	// .
	LanguageCode *string

	// 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.
	Tags map[string]string

	// The custom description of the message template.
	TemplateDescription *string

	// 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.
	Version *string

	// 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 (https://docs.aws.amazon.com/polly/latest/dg/what-is.html) .
	VoiceId *string

	noSmithyDocumentSerde
}

// Specifies the settings for a wait activity in a journey. 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.
type WaitActivity struct {

	// The unique identifier for the next activity to perform, after performing the
	// wait activity.
	NextActivity *string

	// The amount of time to wait or the date and time when the activity moves
	// participants to the next activity in the journey.
	WaitTime *WaitTime

	noSmithyDocumentSerde
}

// Specifies a duration or a date and time that indicates when Amazon Pinpoint
// determines whether an activity's conditions have been met or an activity moves
// participants to the next activity in a journey.
type WaitTime struct {

	// 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.
	WaitFor *string

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

	noSmithyDocumentSerde
}

// Specifies the default settings for an application.
type WriteApplicationSettingsRequest struct {

	// 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.
	CampaignHook *CampaignHook

	// Specifies whether to enable application-related alarms in Amazon CloudWatch.
	CloudWatchMetricsEnabled bool

	EventTaggingEnabled bool

	// 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.
	JourneyLimits *ApplicationSettingsJourneyLimits

	// 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.
	Limits *CampaignLimits

	// 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.
	QuietTime *QuietTime

	noSmithyDocumentSerde
}

// Specifies the configuration and other settings for a campaign.
type WriteCampaignRequest struct {

	// An array of requests that defines additional treatments for the campaign, in
	// addition to the default treatment for the campaign.
	AdditionalTreatments []WriteTreatmentResource

	// 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.
	CustomDeliveryConfiguration *CustomDeliveryConfiguration

	// A custom description of the campaign.
	Description *string

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

	// 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.
	Hook *CampaignHook

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

	// The messaging limits for the campaign.
	Limits *CampaignLimits

	// The message configuration settings for the campaign.
	MessageConfiguration *MessageConfiguration

	// A custom name for the campaign.
	Name *string

	// 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.
	Priority int32

	// The schedule settings for the campaign.
	Schedule *Schedule

	// The unique identifier for the segment to associate with the campaign.
	SegmentId *string

	// The version of the segment to associate with the campaign.
	SegmentVersion int32

	// 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 (https://docs.aws.amazon.com/pinpoint/latest/apireference/tags-resource-arn.html)
	// in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi (https://docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/index.html)
	// commands in the AWS Command Line Interface Documentation or
	// resourcegroupstaggingapi (https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/resourcegroupstaggingapi/package-summary.html)
	// 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.
	Tags map[string]string

	// The message template to use for the campaign.
	TemplateConfiguration *TemplateConfiguration

	// A custom description of the default treatment for the campaign.
	TreatmentDescription *string

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

	noSmithyDocumentSerde
}

// Specifies the Amazon Resource Name (ARN) of an event stream to publish events
// to and the AWS Identity and Access Management (IAM) role to use when publishing
// those events.
type WriteEventStream struct {

	// 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:region:account-id:stream/stream_name For a Kinesis Data Firehose
	// delivery stream, the ARN format is:
	// arn:aws:firehose:region:account-id:deliverystream/stream_name
	//
	// This member is required.
	DestinationStreamArn *string

	// The AWS Identity and Access Management (IAM) role that authorizes Amazon
	// Pinpoint to publish event data to the stream in your AWS account.
	//
	// This member is required.
	RoleArn *string

	noSmithyDocumentSerde
}

// Specifies the configuration and other settings for a journey.
type WriteJourneyRequest struct {

	// 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.
	//
	// This member is required.
	Name *string

	// 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.
	Activities map[string]Activity

	// The time when journey will stop sending messages. QuietTime should be
	// configured first and SendingSchedule should be set to true.
	ClosedDays *ClosedDays

	// The date, in ISO 8601 format, when the journey was created.
	CreationDate *string

	// The channel-specific configurations for the journey.
	JourneyChannelSettings *JourneyChannelSettings

	// The date, in ISO 8601 format, when the journey was last modified.
	LastModifiedDate *string

	// The messaging and entry limits for the journey.
	Limits *JourneyLimits

	// 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.
	LocalTime bool

	// The time when journey allow to send messages. QuietTime should be configured
	// first and SendingSchedule should be set to true.
	OpenHours *OpenHours

	// 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.
	QuietTime *QuietTime

	// The frequency with which Amazon Pinpoint evaluates segment and event data for
	// the journey, as a duration in ISO 8601 format.
	RefreshFrequency *string

	// Indicates whether the journey participants should be refreshed when a segment
	// is updated.
	RefreshOnSegmentUpdate bool

	// The schedule settings for the journey.
	Schedule *JourneySchedule

	// Indicates if journey has Advance Quiet Time enabled. This flag should be set to
	// true in order to allow using OpenHours and ClosedDays.
	SendingSchedule bool

	// 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.
	StartActivity *string

	// The segment that defines which users are participants in the journey.
	StartCondition *StartCondition

	// 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.
	State State

	// An array of time zone estimation methods, if any, to use for determining an
	// Endpoints (https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-endpoints-endpoint-id.html)
	// 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.
	TimezoneEstimationMethods []TimezoneEstimationMethodsElement

	// Specifies whether endpoints in quiet hours should enter a wait till the end of
	// their quiet hours.
	WaitForQuietTime bool

	noSmithyDocumentSerde
}

// Specifies the configuration, dimension, and other settings for a segment. A
// WriteSegmentRequest object can include a Dimensions object or a SegmentGroups
// object, but not both.
type WriteSegmentRequest struct {

	// The criteria that define the dimensions for the segment.
	Dimensions *SegmentDimensions

	// The name of the segment.
	Name *string

	// 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.
	SegmentGroups *SegmentGroupList

	// 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 (https://docs.aws.amazon.com/pinpoint/latest/apireference/tags-resource-arn.html)
	// in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi (https://docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/index.html)
	// commands in the AWS Command Line Interface Documentation or
	// resourcegroupstaggingapi (https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/resourcegroupstaggingapi/package-summary.html)
	// 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.
	Tags map[string]string

	noSmithyDocumentSerde
}

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

	// The allocated percentage of users (segment members) to send the treatment to.
	//
	// This member is required.
	SizePercent int32

	// 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.
	CustomDeliveryConfiguration *CustomDeliveryConfiguration

	// The message configuration settings for the treatment.
	MessageConfiguration *MessageConfiguration

	// The schedule settings for the treatment.
	Schedule *Schedule

	// The message template to use for the treatment.
	TemplateConfiguration *TemplateConfiguration

	// A custom description of the treatment.
	TreatmentDescription *string

	// A custom name for the treatment.
	TreatmentName *string

	noSmithyDocumentSerde
}

type noSmithyDocumentSerde = smithydocument.NoSerde