Serialized Form (AWS Java SDK for Amazon Pinpoint 1.11.527 API)

Package com.amazonaws.services.pinpoint.model
- Class com.amazonaws.services.pinpoint.model.ActivitiesResponse extends Object implements Serializable
  - Serialized Fields
    - item
```
List<E> item
```
      List of campaign activities
    - nextToken
```
String nextToken
```
      The string that you use in a subsequent request to get the next page of results in a paginated response.
- Class com.amazonaws.services.pinpoint.model.ActivityResponse extends Object implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The ID of the application to which the campaign applies.
    - campaignId
```
String campaignId
```
      The ID of the campaign to which the activity applies.
    - end
```
String end
```
      The actual time the activity was marked CANCELLED or COMPLETED. Provided in ISO 8601 format.
    - id
```
String id
```
      The unique activity ID.
    - result
```
String result
```
      Indicates whether the activity succeeded. Valid values: SUCCESS, FAIL
    - scheduledStart
```
String scheduledStart
```
      The scheduled start time for the activity in ISO 8601 format.
    - start
```
String start
```
      The actual start time of the activity in ISO 8601 format.
    - state
```
String state
```
      The state of the activity. Valid values: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, COMPLETED
    - successfulEndpointCount
```
Integer successfulEndpointCount
```
      The total number of endpoints to which the campaign successfully delivered messages.
    - timezonesCompletedCount
```
Integer timezonesCompletedCount
```
      The total number of timezones completed.
    - timezonesTotalCount
```
Integer timezonesTotalCount
```
      The total number of unique timezones present in the segment.
    - totalEndpointCount
```
Integer totalEndpointCount
```
      The total number of endpoints to which the campaign attempts to deliver messages.
    - treatmentId
```
String treatmentId
```
      The ID of a variation of the campaign used for A/B testing.
- Class com.amazonaws.services.pinpoint.model.AddressConfiguration extends Object implements Serializable
  - Serialized Fields
    - bodyOverride
```
String bodyOverride
```
      Body override. If specified will override default body.
    - channelType
```
String channelType
```
      The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU
    - context
```
Map<K,V> context
```
      A map of custom attributes to attributes to be attached to the message for this address. This payload is added to the push notification's 'data.pinpoint' object or added to the email/sms delivery receipt event attributes.
    - rawContent
```
String rawContent
```
      The Raw JSON formatted string to be used as the payload. This value overrides the message.
    - substitutions
```
Map<K,V> substitutions
```
      A map of substitution values for the message to be merged with the DefaultMessage's substitutions. Substitutions on this map take precedence over the all other substitutions.
    - titleOverride
```
String titleOverride
```
      Title override. If specified will override default title if applicable.
- Class com.amazonaws.services.pinpoint.model.ADMChannelRequest extends Object implements Serializable
  - Serialized Fields
    - clientId
```
String clientId
```
      The Client ID that you obtained from the Amazon App Distribution Portal.
    - clientSecret
```
String clientSecret
```
      The Client Secret that you obtained from the Amazon App Distribution Portal.
    - enabled
```
Boolean enabled
```
      Indicates whether or not the channel is enabled for sending messages.
- Class com.amazonaws.services.pinpoint.model.ADMChannelResponse extends Object implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The ID of the application to which the channel applies.
    - creationDate
```
String creationDate
```
      The date and time when this channel was created.
    - enabled
```
Boolean enabled
```
      Indicates whether or not the channel is enabled for sending messages.
    - hasCredential
```
Boolean hasCredential
```
      Not used. Retained for backwards compatibility.
    - id
```
String id
```
      (Deprecated) An identifier for the channel. Retained for backwards compatibility.
    - isArchived
```
Boolean isArchived
```
      Indicates whether or not the channel is archived.
    - lastModifiedBy
```
String lastModifiedBy
```
      The user who last updated this channel.
    - lastModifiedDate
```
String lastModifiedDate
```
      The date and time when this channel was last modified.
    - platform
```
String platform
```
      The platform type. For this channel, the value is always "ADM."
    - version
```
Integer version
```
      The channel version.
- Class com.amazonaws.services.pinpoint.model.ADMMessage extends Object implements Serializable
  - Serialized Fields
    - action
```
String action
```
      The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL
    - body
```
String body
```
      The message body of the notification.
    - consolidationKey
```
String consolidationKey
```
      Optional. Arbitrary string used to indicate multiple messages are logically the same and that ADM is allowed to drop previously enqueued messages in favor of this one.
    - data
```
Map<K,V> data
```
      The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
    - expiresAfter
```
String expiresAfter
```
      Optional. Number of seconds ADM should retain the message if the device is offline
    - iconReference
```
String iconReference
```
      The icon image name of the asset saved in your application.
    - imageIconUrl
```
String imageIconUrl
```
      The URL that points to an image used as the large icon to the notification content view.
    - imageUrl
```
String imageUrl
```
      The URL that points to an image used in the push notification.
    - mD5
```
String mD5
```
      Optional. Base-64-encoded MD5 checksum of the data parameter. Used to verify data integrity
    - rawContent
```
String rawContent
```
      The Raw JSON formatted string to be used as the payload. This value overrides the message.
    - silentPush
```
Boolean silentPush
```
      Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
    - smallImageIconUrl
```
String smallImageIconUrl
```
      The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view
    - sound
```
String sound
```
      Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/
    - substitutions
```
Map<K,V> substitutions
```
      Default message substitutions. Can be overridden by individual address substitutions.
    - title
```
String title
```
      The message title that displays above the message on the user's device.
    - url
```
String url
```
      The URL to open in the user's mobile browser. Used if the value for Action is URL.
- Class com.amazonaws.services.pinpoint.model.AmazonPinpointException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.pinpoint.model.APNSChannelRequest extends Object implements Serializable
  - Serialized Fields
    - bundleId
```
String bundleId
```
      The bundle id used for APNs Tokens.
    - certificate
```
String certificate
```
      The distribution certificate from Apple.
    - defaultAuthenticationMethod
```
String defaultAuthenticationMethod
```
      The default authentication method used for APNs.
    - enabled
```
Boolean enabled
```
      If the channel is enabled for sending messages.
    - privateKey
```
String privateKey
```
      The certificate private key.
    - teamId
```
String teamId
```
      The team id used for APNs Tokens.
    - tokenKey
```
String tokenKey
```
      The token key used for APNs Tokens.
    - tokenKeyId
```
String tokenKeyId
```
      The token key used for APNs Tokens.
- Class com.amazonaws.services.pinpoint.model.APNSChannelResponse extends Object implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The ID of the application that the channel applies to.
    - creationDate
```
String creationDate
```
      The date and time when this channel was created.
    - defaultAuthenticationMethod
```
String defaultAuthenticationMethod
```
      The default authentication method used for APNs.
    - enabled
```
Boolean enabled
```
      If the channel is enabled for sending messages.
    - hasCredential
```
Boolean hasCredential
```
      Not used. Retained for backwards compatibility.
    - hasTokenKey
```
Boolean hasTokenKey
```
      Indicates whether the channel is configured with a key for APNs token authentication. Provide a token key by setting the TokenKey attribute.
    - id
```
String id
```
      (Deprecated) An identifier for the channel. Retained for backwards compatibility.
    - isArchived
```
Boolean isArchived
```
      Indicates whether or not the channel is archived.
    - lastModifiedBy
```
String lastModifiedBy
```
      The user who last updated this channel.
    - lastModifiedDate
```
String lastModifiedDate
```
      The date and time when this channel was last modified.
    - platform
```
String platform
```
      The platform type. For this channel, the value is always "ADM."
    - version
```
Integer version
```
      The channel version.
- Class com.amazonaws.services.pinpoint.model.APNSMessage extends Object implements Serializable
  - Serialized Fields
    - action
```
String action
```
      The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL
    - badge
```
Integer badge
```
      Include this key when you want the system to modify the badge of your app icon. If this key is not included in the dictionary, the badge is not changed. To remove the badge, set the value of this key to 0.
    - body
```
String body
```
      The message body of the notification.
    - category
```
String category
```
      Provide this key with a string value that represents the notification's type. This value corresponds to the value in the identifier property of one of your app's registered categories.
    - collapseId
```
String collapseId
```
      An ID that, if assigned to multiple messages, causes APNs to coalesce the messages into a single push notification instead of delivering each message individually. The value must not exceed 64 bytes. Amazon Pinpoint uses this value to set the apns-collapse-id request header when it sends the message to APNs.
    - data
```
Map<K,V> data
```
      The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
    - mediaUrl
```
String mediaUrl
```
      A URL that refers to the location of an image or video that you want to display in the push notification.
    - preferredAuthenticationMethod
```
String preferredAuthenticationMethod
```
      The preferred authentication method, either "CERTIFICATE" or "TOKEN"
    - priority
```
String priority
```
      The message priority. Amazon Pinpoint uses this value to set the apns-priority request header when it sends the message to APNs. Accepts the following values: "5" - Low priority. Messages might be delayed, delivered in groups, and throttled. "10" - High priority. Messages are sent immediately. High priority messages must cause an alert, sound, or badge on the receiving device. The default value is "10". The equivalent values for FCM or GCM messages are "normal" and "high". Amazon Pinpoint accepts these values for APNs messages and converts them. For more information about the apns-priority parameter, see Communicating with APNs in the APNs Local and Remote Notification Programming Guide.
    - rawContent
```
String rawContent
```
      The Raw JSON formatted string to be used as the payload. This value overrides the message.
    - silentPush
```
Boolean silentPush
```
      Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
    - sound
```
String sound
```
      Include this key when you want the system to play a sound. The value of this key is the name of a sound file in your app's main bundle or in the Library/Sounds folder of your app's data container. If the sound file cannot be found, or if you specify defaultfor the value, the system plays the default alert sound.
    - substitutions
```
Map<K,V> substitutions
```
      Default message substitutions. Can be overridden by individual address substitutions.
    - threadId
```
String threadId
```
      Provide this key with a string value that represents the app-specific identifier for grouping notifications. If you provide a Notification Content app extension, you can use this value to group your notifications together.
    - timeToLive
```
Integer timeToLive
```
      The length of time (in seconds) that APNs stores and attempts to deliver the message. If the value is 0, APNs does not store the message or attempt to deliver it more than once. Amazon Pinpoint uses this value to set the apns-expiration request header when it sends the message to APNs.
    - title
```
String title
```
      The message title that displays above the message on the user's device.
    - url
```
String url
```
      The URL to open in the user's mobile browser. Used if the value for Action is URL.
- Class com.amazonaws.services.pinpoint.model.APNSSandboxChannelRequest extends Object implements Serializable
  - Serialized Fields
    - bundleId
```
String bundleId
```
      The bundle id used for APNs Tokens.
    - certificate
```
String certificate
```
      The distribution certificate from Apple.
    - defaultAuthenticationMethod
```
String defaultAuthenticationMethod
```
      The default authentication method used for APNs.
    - enabled
```
Boolean enabled
```
      If the channel is enabled for sending messages.
    - privateKey
```
String privateKey
```
      The certificate private key.
    - teamId
```
String teamId
```
      The team id used for APNs Tokens.
    - tokenKey
```
String tokenKey
```
      The token key used for APNs Tokens.
    - tokenKeyId
```
String tokenKeyId
```
      The token key used for APNs Tokens.
- Class com.amazonaws.services.pinpoint.model.APNSSandboxChannelResponse extends Object implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The ID of the application to which the channel applies.
    - creationDate
```
String creationDate
```
      When was this segment created
    - defaultAuthenticationMethod
```
String defaultAuthenticationMethod
```
      The default authentication method used for APNs.
    - enabled
```
Boolean enabled
```
      If the channel is enabled for sending messages.
    - hasCredential
```
Boolean hasCredential
```
      Not used. Retained for backwards compatibility.
    - hasTokenKey
```
Boolean hasTokenKey
```
      Indicates whether the channel is configured with a key for APNs token authentication. Provide a token key by setting the TokenKey attribute.
    - id
```
String id
```
      Channel ID. Not used, only for backwards compatibility.
    - isArchived
```
Boolean isArchived
```
      Is this channel archived
    - lastModifiedBy
```
String lastModifiedBy
```
      Who last updated this entry
    - lastModifiedDate
```
String lastModifiedDate
```
      Last date this was updated
    - platform
```
String platform
```
      The platform type. Will be APNS_SANDBOX.
    - version
```
Integer version
```
      Version of channel
- Class com.amazonaws.services.pinpoint.model.APNSVoipChannelRequest extends Object implements Serializable
  - Serialized Fields
    - bundleId
```
String bundleId
```
      The bundle id used for APNs Tokens.
    - certificate
```
String certificate
```
      The distribution certificate from Apple.
    - defaultAuthenticationMethod
```
String defaultAuthenticationMethod
```
      The default authentication method used for APNs.
    - enabled
```
Boolean enabled
```
      If the channel is enabled for sending messages.
    - privateKey
```
String privateKey
```
      The certificate private key.
    - teamId
```
String teamId
```
      The team id used for APNs Tokens.
    - tokenKey
```
String tokenKey
```
      The token key used for APNs Tokens.
    - tokenKeyId
```
String tokenKeyId
```
      The token key used for APNs Tokens.
- Class com.amazonaws.services.pinpoint.model.APNSVoipChannelResponse extends Object implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      Application id
    - creationDate
```
String creationDate
```
      When was this segment created
    - defaultAuthenticationMethod
```
String defaultAuthenticationMethod
```
      The default authentication method used for APNs.
    - enabled
```
Boolean enabled
```
      If the channel is enabled for sending messages.
    - hasCredential
```
Boolean hasCredential
```
      Not used. Retained for backwards compatibility.
    - hasTokenKey
```
Boolean hasTokenKey
```
      If the channel is registered with a token key for authentication.
    - id
```
String id
```
      Channel ID. Not used, only for backwards compatibility.
    - isArchived
```
Boolean isArchived
```
      Is this channel archived
    - lastModifiedBy
```
String lastModifiedBy
```
      Who made the last change
    - lastModifiedDate
```
String lastModifiedDate
```
      Last date this was updated
    - platform
```
String platform
```
      The platform type. Will be APNS.
    - version
```
Integer version
```
      Version of channel
- Class com.amazonaws.services.pinpoint.model.APNSVoipSandboxChannelRequest extends Object implements Serializable
  - Serialized Fields
    - bundleId
```
String bundleId
```
      The bundle id used for APNs Tokens.
    - certificate
```
String certificate
```
      The distribution certificate from Apple.
    - defaultAuthenticationMethod
```
String defaultAuthenticationMethod
```
      The default authentication method used for APNs.
    - enabled
```
Boolean enabled
```
      If the channel is enabled for sending messages.
    - privateKey
```
String privateKey
```
      The certificate private key.
    - teamId
```
String teamId
```
      The team id used for APNs Tokens.
    - tokenKey
```
String tokenKey
```
      The token key used for APNs Tokens.
    - tokenKeyId
```
String tokenKeyId
```
      The token key used for APNs Tokens.
- Class com.amazonaws.services.pinpoint.model.APNSVoipSandboxChannelResponse extends Object implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      Application id
    - creationDate
```
String creationDate
```
      When was this segment created
    - defaultAuthenticationMethod
```
String defaultAuthenticationMethod
```
      The default authentication method used for APNs.
    - enabled
```
Boolean enabled
```
      If the channel is enabled for sending messages.
    - hasCredential
```
Boolean hasCredential
```
      Not used. Retained for backwards compatibility.
    - hasTokenKey
```
Boolean hasTokenKey
```
      If the channel is registered with a token key for authentication.
    - id
```
String id
```
      Channel ID. Not used, only for backwards compatibility.
    - isArchived
```
Boolean isArchived
```
      Is this channel archived
    - lastModifiedBy
```
String lastModifiedBy
```
      Who made the last change
    - lastModifiedDate
```
String lastModifiedDate
```
      Last date this was updated
    - platform
```
String platform
```
      The platform type. Will be APNS.
    - version
```
Integer version
```
      Version of channel
- Class com.amazonaws.services.pinpoint.model.ApplicationResponse extends Object implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The arn for the application.
    - id
```
String id
```
      The unique application ID.
    - name
```
String name
```
      The display name of the application.
    - tags
```
Map<K,V> tags
```
      The Tags for the application.
- Class com.amazonaws.services.pinpoint.model.ApplicationSettingsResource extends Object implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID for the application.
    - campaignHook
```
CampaignHook campaignHook
```
      Default campaign hook.
    - lastModifiedDate
```
String lastModifiedDate
```
      The date that the settings were last updated in ISO 8601 format.
    - limits
```
CampaignLimits limits
```
      The default campaign limits for the app. These limits apply to each campaign for the app, unless the campaign overrides the default with limits of its own.
    - quietTime
```
QuietTime quietTime
```
      The default quiet time for the app. Campaigns in the app don't send messages to endpoints during the quiet time. Note: Make sure that your endpoints include the Demographics.Timezone attribute if you plan to enable a quiet time for your app. If your endpoints don't include this attribute, they'll receive the messages that you send them, even if quiet time is enabled. When you set up an app to use quiet time, campaigns in that app don't send messages during the time range you specified, as long as all of the following are true: - The endpoint includes a valid Demographic.Timezone attribute. - The current time in the endpoint's time zone is later than or equal to the time specified in the QuietTime.Start attribute for the app (or campaign, if applicable). - The current time in the endpoint's time zone is earlier than or equal to the time specified in the QuietTime.End attribute for the app (or campaign, if applicable). Individual campaigns within the app can have their own quiet time settings, which override the quiet time settings at the app level.
- Class com.amazonaws.services.pinpoint.model.ApplicationsResponse extends Object implements Serializable
  - Serialized Fields
    - item
```
List<E> item
```
      List of applications returned in this page.
    - nextToken
```
String nextToken
```
      The string that you use in a subsequent request to get the next page of results in a paginated response.
- Class com.amazonaws.services.pinpoint.model.AttributeDimension extends Object implements Serializable
  - Serialized Fields
    - attributeType
```
String attributeType
```
      The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
    - values
```
List<E> values
```
      The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
- Class com.amazonaws.services.pinpoint.model.AttributesResource extends Object implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID for the application.
    - attributeType
```
String attributeType
```
      The attribute type for the application.
    - attributes
```
List<E> attributes
```
      The attributes for the application.
- Class com.amazonaws.services.pinpoint.model.BadRequestException extends AmazonPinpointException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - requestID
```
String requestID
```
      The unique message body ID.
- Class com.amazonaws.services.pinpoint.model.BaiduChannelRequest extends Object implements Serializable
  - Serialized Fields
    - apiKey
```
String apiKey
```
      Platform credential API key from Baidu.
    - enabled
```
Boolean enabled
```
      If the channel is enabled for sending messages.
    - secretKey
```
String secretKey
```
      Platform credential Secret key from Baidu.
- Class com.amazonaws.services.pinpoint.model.BaiduChannelResponse extends Object implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      Application id
    - creationDate
```
String creationDate
```
      When was this segment created
    - credential
```
String credential
```
      The Baidu API key from Baidu.
    - enabled
```
Boolean enabled
```
      If the channel is enabled for sending messages.
    - hasCredential
```
Boolean hasCredential
```
      Not used. Retained for backwards compatibility.
    - id
```
String id
```
      Channel ID. Not used, only for backwards compatibility.
    - isArchived
```
Boolean isArchived
```
      Is this channel archived
    - lastModifiedBy
```
String lastModifiedBy
```
      Who made the last change
    - lastModifiedDate
```
String lastModifiedDate
```
      Last date this was updated
    - platform
```
String platform
```
      The platform type. Will be BAIDU
    - version
```
Integer version
```
      Version of channel
- Class com.amazonaws.services.pinpoint.model.BaiduMessage extends Object implements Serializable
  - Serialized Fields
    - action
```
String action
```
      The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL
    - body
```
String body
```
      The message body of the notification.
    - data
```
Map<K,V> data
```
      The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
    - iconReference
```
String iconReference
```
      The icon image name of the asset saved in your application.
    - imageIconUrl
```
String imageIconUrl
```
      The URL that points to an image used as the large icon to the notification content view.
    - imageUrl
```
String imageUrl
```
      The URL that points to an image used in the push notification.
    - rawContent
```
String rawContent
```
      The Raw JSON formatted string to be used as the payload. This value overrides the message.
    - silentPush
```
Boolean silentPush
```
      Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
    - smallImageIconUrl
```
String smallImageIconUrl
```
      The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view
    - sound
```
String sound
```
      Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/
    - substitutions
```
Map<K,V> substitutions
```
      Default message substitutions. Can be overridden by individual address substitutions.
    - timeToLive
```
Integer timeToLive
```
      This parameter specifies how long (in seconds) the message should be kept in Baidu storage if the device is offline. The and the default value and the maximum time to live supported is 7 days (604800 seconds)
    - title
```
String title
```
      The message title that displays above the message on the user's device.
    - url
```
String url
```
      The URL to open in the user's mobile browser. Used if the value for Action is URL.
- Class com.amazonaws.services.pinpoint.model.CampaignEmailMessage extends Object implements Serializable
  - Serialized Fields
    - body
```
String body
```
      The email text body.
    - fromAddress
```
String fromAddress
```
      The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.
    - htmlBody
```
String htmlBody
```
      The email html body.
    - title
```
String title
```
      The email title (Or subject).
- Class com.amazonaws.services.pinpoint.model.CampaignEventFilter extends Object implements Serializable
  - Serialized Fields
    - dimensions
```
EventDimensions dimensions
```
      An object that defines the dimensions for the event filter.
    - filterType
```
String filterType
```
      The type of event that causes the campaign to be sent. Possible values: SYSTEM - Send the campaign when a system event occurs. See the System resource for more information. ENDPOINT - Send the campaign when an endpoint event occurs. See the Event resource for more information.
- Class com.amazonaws.services.pinpoint.model.CampaignHook extends Object implements Serializable
  - Serialized Fields
    - lambdaFunctionName
```
String lambdaFunctionName
```
      Lambda function name or arn to be called for delivery
    - mode
```
String mode
```
      What mode Lambda should be invoked in.
    - webUrl
```
String webUrl
```
      Web URL to call for hook. If the URL has authentication specified it will be added as authentication to the request
- Class com.amazonaws.services.pinpoint.model.CampaignLimits extends Object implements Serializable
  - Serialized Fields
    - daily
```
Integer daily
```
      The maximum number of messages that each campaign can send to a single endpoint in a 24-hour period.
    - maximumDuration
```
Integer maximumDuration
```
      The length of time (in seconds) that the campaign can run before it ends and message deliveries stop. This duration begins at the scheduled start time for the campaign. The minimum value is 60.
    - messagesPerSecond
```
Integer messagesPerSecond
```
      The number of messages that the campaign can send per second. The minimum value is 50, and the maximum is 20000.
    - total
```
Integer total
```
      The maximum number of messages that an individual campaign can send to a single endpoint over the course of the campaign.
- Class com.amazonaws.services.pinpoint.model.CampaignResponse extends Object implements Serializable
  - Serialized Fields
    - additionalTreatments
```
List<E> additionalTreatments
```
      Treatments that are defined in addition to the default treatment.
    - applicationId
```
String applicationId
```
      The ID of the application to which the campaign applies.
    - arn
```
String arn
```
      The arn for the campaign.
    - creationDate
```
String creationDate
```
      The date the campaign was created in ISO 8601 format.
    - defaultState
```
CampaignState defaultState
```
      The status of the campaign's default treatment. Only present for A/B test campaigns.
    - description
```
String description
```
      A description of the campaign.
    - holdoutPercent
```
Integer holdoutPercent
```
      The allocated percentage of end users who will not receive messages from this campaign.
    - hook
```
CampaignHook hook
```
      Campaign hook information.
    - id
```
String id
```
      The unique campaign ID.
    - isPaused
```
Boolean isPaused
```
      Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.
    - lastModifiedDate
```
String lastModifiedDate
```
      The date the campaign was last updated in ISO 8601 format.
    - limits
```
CampaignLimits limits
```
      The campaign limits settings.
    - messageConfiguration
```
MessageConfiguration messageConfiguration
```
      The message configuration settings.
    - name
```
String name
```
      The custom name of the campaign.
    - schedule
```
Schedule schedule
```
      The campaign schedule.
    - segmentId
```
String segmentId
```
      The ID of the segment to which the campaign sends messages.
    - segmentVersion
```
Integer segmentVersion
```
      The version of the segment to which the campaign sends messages.
    - state
```
CampaignState state
```
      The campaign status. An A/B test campaign will have a status of COMPLETED only when all treatments have a status of COMPLETED.
    - tags
```
Map<K,V> tags
```
      The Tags for the campaign.
    - treatmentDescription
```
String treatmentDescription
```
      A custom description for the treatment.
    - treatmentName
```
String treatmentName
```
      The custom name of a variation of the campaign used for A/B testing.
    - version
```
Integer version
```
      The campaign version number.
- Class com.amazonaws.services.pinpoint.model.CampaignSmsMessage extends Object implements Serializable
  - Serialized Fields
    - body
```
String body
```
      The SMS text body.
    - messageType
```
String messageType
```
      Is this is a transactional SMS message, otherwise a promotional message.
    - senderId
```
String senderId
```
      Sender ID of sent message.
- Class com.amazonaws.services.pinpoint.model.CampaignsResponse extends Object implements Serializable
  - Serialized Fields
    - item
```
List<E> item
```
      A list of campaigns.
    - nextToken
```
String nextToken
```
      The string that you use in a subsequent request to get the next page of results in a paginated response.
- Class com.amazonaws.services.pinpoint.model.CampaignState extends Object implements Serializable
  - Serialized Fields
    - campaignStatus
```
String campaignStatus
```
      The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED
- Class com.amazonaws.services.pinpoint.model.ChannelResponse extends Object implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      Application id
    - creationDate
```
String creationDate
```
      When was this segment created
    - enabled
```
Boolean enabled
```
      If the channel is enabled for sending messages.
    - hasCredential
```
Boolean hasCredential
```
      Not used. Retained for backwards compatibility.
    - id
```
String id
```
      Channel ID. Not used, only for backwards compatibility.
    - isArchived
```
Boolean isArchived
```
      Is this channel archived
    - lastModifiedBy
```
String lastModifiedBy
```
      Who made the last change
    - lastModifiedDate
```
String lastModifiedDate
```
      Last date this was updated
    - version
```
Integer version
```
      Version of channel
- Class com.amazonaws.services.pinpoint.model.ChannelsResponse extends Object implements Serializable
  - Serialized Fields
    - channels
```
Map<K,V> channels
```
      A map of channels, with the ChannelType as the key and the Channel as the value.
- Class com.amazonaws.services.pinpoint.model.CreateApplicationRequest extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The display name of the application. Used in the Amazon Pinpoint console.
    - tags
```
Map<K,V> tags
```
      The Tags for the app.
- Class com.amazonaws.services.pinpoint.model.CreateAppRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - createApplicationRequest
```
CreateApplicationRequest createApplicationRequest
```
- Class com.amazonaws.services.pinpoint.model.CreateAppResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - applicationResponse
```
ApplicationResponse applicationResponse
```
- Class com.amazonaws.services.pinpoint.model.CreateCampaignRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
    - writeCampaignRequest
```
WriteCampaignRequest writeCampaignRequest
```
- Class com.amazonaws.services.pinpoint.model.CreateCampaignResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - campaignResponse
```
CampaignResponse campaignResponse
```
- Class com.amazonaws.services.pinpoint.model.CreateExportJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
    - exportJobRequest
```
ExportJobRequest exportJobRequest
```
- Class com.amazonaws.services.pinpoint.model.CreateExportJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - exportJobResponse
```
ExportJobResponse exportJobResponse
```
- Class com.amazonaws.services.pinpoint.model.CreateImportJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
    - importJobRequest
```
ImportJobRequest importJobRequest
```
- Class com.amazonaws.services.pinpoint.model.CreateImportJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - importJobResponse
```
ImportJobResponse importJobResponse
```
- Class com.amazonaws.services.pinpoint.model.CreateSegmentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
    - writeSegmentRequest
```
WriteSegmentRequest writeSegmentRequest
```
- Class com.amazonaws.services.pinpoint.model.CreateSegmentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - segmentResponse
```
SegmentResponse segmentResponse
```
- Class com.amazonaws.services.pinpoint.model.DefaultMessage extends Object implements Serializable
  - Serialized Fields
    - body
```
String body
```
      The message body of the notification, the email body or the text message.
    - substitutions
```
Map<K,V> substitutions
```
      Default message substitutions. Can be overridden by individual address substitutions.
- Class com.amazonaws.services.pinpoint.model.DefaultPushNotificationMessage extends Object implements Serializable
  - Serialized Fields
    - action
```
String action
```
      The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL
    - body
```
String body
```
      The message body of the notification.
    - data
```
Map<K,V> data
```
      The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
    - silentPush
```
Boolean silentPush
```
      Indicates if the message should display on the recipient's device. You can use silent pushes for remote configuration or to deliver messages to in-app notification centers.
    - substitutions
```
Map<K,V> substitutions
```
      Default message substitutions. Can be overridden by individual address substitutions.
    - title
```
String title
```
      The message title that displays above the message on the user's device.
    - url
```
String url
```
      The URL to open in the user's mobile browser. Used if the value for Action is URL.
- Class com.amazonaws.services.pinpoint.model.DeleteAdmChannelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
- Class com.amazonaws.services.pinpoint.model.DeleteAdmChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - aDMChannelResponse
```
ADMChannelResponse aDMChannelResponse
```
- Class com.amazonaws.services.pinpoint.model.DeleteApnsChannelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
- Class com.amazonaws.services.pinpoint.model.DeleteApnsChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - aPNSChannelResponse
```
APNSChannelResponse aPNSChannelResponse
```
- Class com.amazonaws.services.pinpoint.model.DeleteApnsSandboxChannelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
- Class com.amazonaws.services.pinpoint.model.DeleteApnsSandboxChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - aPNSSandboxChannelResponse
```
APNSSandboxChannelResponse aPNSSandboxChannelResponse
```
- Class com.amazonaws.services.pinpoint.model.DeleteApnsVoipChannelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
- Class com.amazonaws.services.pinpoint.model.DeleteApnsVoipChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - aPNSVoipChannelResponse
```
APNSVoipChannelResponse aPNSVoipChannelResponse
```
- Class com.amazonaws.services.pinpoint.model.DeleteApnsVoipSandboxChannelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
- Class com.amazonaws.services.pinpoint.model.DeleteApnsVoipSandboxChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - aPNSVoipSandboxChannelResponse
```
APNSVoipSandboxChannelResponse aPNSVoipSandboxChannelResponse
```
- Class com.amazonaws.services.pinpoint.model.DeleteAppRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
- Class com.amazonaws.services.pinpoint.model.DeleteAppResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - applicationResponse
```
ApplicationResponse applicationResponse
```
- Class com.amazonaws.services.pinpoint.model.DeleteBaiduChannelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
- Class com.amazonaws.services.pinpoint.model.DeleteBaiduChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - baiduChannelResponse
```
BaiduChannelResponse baiduChannelResponse
```
- Class com.amazonaws.services.pinpoint.model.DeleteCampaignRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
    - campaignId
```
String campaignId
```
      The unique ID of the campaign.
- Class com.amazonaws.services.pinpoint.model.DeleteCampaignResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - campaignResponse
```
CampaignResponse campaignResponse
```
- Class com.amazonaws.services.pinpoint.model.DeleteEmailChannelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
- Class com.amazonaws.services.pinpoint.model.DeleteEmailChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - emailChannelResponse
```
EmailChannelResponse emailChannelResponse
```
- Class com.amazonaws.services.pinpoint.model.DeleteEndpointRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
    - endpointId
```
String endpointId
```
      The unique ID of the endpoint.
- Class com.amazonaws.services.pinpoint.model.DeleteEndpointResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - endpointResponse
```
EndpointResponse endpointResponse
```
- Class com.amazonaws.services.pinpoint.model.DeleteEventStreamRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
- Class com.amazonaws.services.pinpoint.model.DeleteEventStreamResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - eventStream
```
EventStream eventStream
```
- Class com.amazonaws.services.pinpoint.model.DeleteGcmChannelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
- Class com.amazonaws.services.pinpoint.model.DeleteGcmChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - gCMChannelResponse
```
GCMChannelResponse gCMChannelResponse
```
- Class com.amazonaws.services.pinpoint.model.DeleteSegmentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
    - segmentId
```
String segmentId
```
      The unique ID of the segment.
- Class com.amazonaws.services.pinpoint.model.DeleteSegmentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - segmentResponse
```
SegmentResponse segmentResponse
```
- Class com.amazonaws.services.pinpoint.model.DeleteSmsChannelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
- Class com.amazonaws.services.pinpoint.model.DeleteSmsChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - sMSChannelResponse
```
SMSChannelResponse sMSChannelResponse
```
- Class com.amazonaws.services.pinpoint.model.DeleteUserEndpointsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
    - userId
```
String userId
```
      The unique ID of the user.
- Class com.amazonaws.services.pinpoint.model.DeleteUserEndpointsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - endpointsResponse
```
EndpointsResponse endpointsResponse
```
- Class com.amazonaws.services.pinpoint.model.DeleteVoiceChannelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
- Class com.amazonaws.services.pinpoint.model.DeleteVoiceChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - voiceChannelResponse
```
VoiceChannelResponse voiceChannelResponse
```
- Class com.amazonaws.services.pinpoint.model.DirectMessageConfiguration extends Object implements Serializable
  - Serialized Fields
    - aDMMessage
```
ADMMessage aDMMessage
```
      The message to ADM channels. Overrides the default push notification message.
    - aPNSMessage
```
APNSMessage aPNSMessage
```
      The message to APNS channels. Overrides the default push notification message.
    - baiduMessage
```
BaiduMessage baiduMessage
```
      The message to Baidu GCM channels. Overrides the default push notification message.
    - defaultMessage
```
DefaultMessage defaultMessage
```
      The default message for all channels.
    - defaultPushNotificationMessage
```
DefaultPushNotificationMessage defaultPushNotificationMessage
```
      The default push notification message for all push channels.
    - emailMessage
```
EmailMessage emailMessage
```
      The message to Email channels. Overrides the default message.
    - gCMMessage
```
GCMMessage gCMMessage
```
      The message to GCM channels. Overrides the default push notification message.
    - sMSMessage
```
SMSMessage sMSMessage
```
      The message to SMS channels. Overrides the default message.
    - voiceMessage
```
VoiceMessage voiceMessage
```
      The message to Voice channels. Overrides the default message.
- Class com.amazonaws.services.pinpoint.model.EmailChannelRequest extends Object implements Serializable
  - Serialized Fields
    - configurationSet
```
String configurationSet
```
      The configuration set that you want to use when you send email using the Pinpoint Email API.
    - enabled
```
Boolean enabled
```
      If the channel is enabled for sending messages.
    - fromAddress
```
String fromAddress
```
      The email address used to send emails from.
    - identity
```
String identity
```
      The ARN of an identity verified with SES.
    - roleArn
```
String roleArn
```
      The ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion service
- Class com.amazonaws.services.pinpoint.model.EmailChannelResponse extends Object implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of the application to which the email channel belongs.
    - configurationSet
```
String configurationSet
```
      The configuration set that you want to use when you send email using the Pinpoint Email API.
    - creationDate
```
String creationDate
```
      The date that the settings were last updated in ISO 8601 format.
    - enabled
```
Boolean enabled
```
      If the channel is enabled for sending messages.
    - fromAddress
```
String fromAddress
```
      The email address used to send emails from.
    - hasCredential
```
Boolean hasCredential
```
      Not used. Retained for backwards compatibility.
    - id
```
String id
```
      Channel ID. Not used, only for backwards compatibility.
    - identity
```
String identity
```
      The ARN of an identity verified with SES.
    - isArchived
```
Boolean isArchived
```
      Is this channel archived
    - lastModifiedBy
```
String lastModifiedBy
```
      Who last updated this entry
    - lastModifiedDate
```
String lastModifiedDate
```
      Last date this was updated
    - messagesPerSecond
```
Integer messagesPerSecond
```
      Messages per second that can be sent
    - platform
```
String platform
```
      Platform type. Will be "EMAIL"
    - roleArn
```
String roleArn
```
      The ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion service
    - version
```
Integer version
```
      Version of channel
- Class com.amazonaws.services.pinpoint.model.EmailMessage extends Object implements Serializable
  - Serialized Fields
    - body
```
String body
```
      The body of the email message.
    - feedbackForwardingAddress
```
String feedbackForwardingAddress
```
      The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled.
    - fromAddress
```
String fromAddress
```
      The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.
    - rawEmail
```
RawEmail rawEmail
```
      An email represented as a raw MIME message.
    - replyToAddresses
```
List<E> replyToAddresses
```
      The reply-to email address(es) for the email. If the recipient replies to the email, each reply-to address will receive the reply.
    - simpleEmail
```
SimpleEmail simpleEmail
```
      An email composed of a subject, a text part and a html part.
    - substitutions
```
Map<K,V> substitutions
```
      Default message substitutions. Can be overridden by individual address substitutions.
- Class com.amazonaws.services.pinpoint.model.EndpointBatchItem extends Object implements Serializable
  - Serialized Fields
    - address
```
String address
```
      The destination for messages that you send to this endpoint. The address varies by channel. For mobile push channels, use the token provided by the push notification service, such as the APNs device token or the 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.
    - attributes
```
Map<K,V> attributes
```
      Custom attributes that describe the endpoint by associating a name with an array of values. For example, an attribute named "interests" might have the values ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create a segment of users to engage with a messaging campaign. The following characters are not recommended in attribute names: # : ? \ /. The Amazon Pinpoint console does not display attributes that include these characters in the name. This limitation does not apply to attribute values.
    - channelType
```
String channelType
```
      The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU
    - demographic
```
EndpointDemographic demographic
```
      The endpoint demographic attributes.
    - effectiveDate
```
String effectiveDate
```
      The last time the endpoint was updated. Provided in ISO 8601 format.
    - endpointStatus
```
String endpointStatus
```
      Unused.
    - id
```
String id
```
      The unique Id for the Endpoint in the batch.
    - location
```
EndpointLocation location
```
      The endpoint location attributes.
    - metrics
```
Map<K,V> metrics
```
      Custom metrics that your app reports to Amazon Pinpoint.
    - optOut
```
String optOut
```
      Indicates whether a user has opted out of receiving messages with one of the following values: ALL - User has opted out of all messages. NONE - Users has not opted out and receives all messages.
    - requestId
```
String requestId
```
      The unique ID for the most recent request to update the endpoint.
    - user
```
EndpointUser user
```
      Custom user-specific attributes that your app reports to Amazon Pinpoint.
- Class com.amazonaws.services.pinpoint.model.EndpointBatchRequest extends Object implements Serializable
  - Serialized Fields
    - item
```
List<E> item
```
      List of items to update. Maximum 100 items
- Class com.amazonaws.services.pinpoint.model.EndpointDemographic extends Object implements Serializable
  - Serialized Fields
    - appVersion
```
String appVersion
```
      The version of the application associated with the endpoint.
    - locale
```
String locale
```
      The endpoint locale in the following format: The ISO 639-1 alpha-2 code, followed by an underscore, followed by an ISO 3166-1 alpha-2 value.
    - make
```
String make
```
      The manufacturer of the endpoint device, such as Apple or Samsung.
    - model
```
String model
```
      The model name or number of the endpoint device, such as iPhone.
    - modelVersion
```
String modelVersion
```
      The model version of the endpoint device.
    - platform
```
String platform
```
      The platform of the endpoint device, such as iOS or Android.
    - platformVersion
```
String platformVersion
```
      The platform version of the endpoint device.
    - timezone
```
String timezone
```
      The timezone of the endpoint. Specified as a tz database value, such as Americas/Los_Angeles.
- Class com.amazonaws.services.pinpoint.model.EndpointItemResponse extends Object implements Serializable
  - Serialized Fields
    - message
```
String message
```
      A custom message associated with the registration of an endpoint when issuing a response.
    - statusCode
```
Integer statusCode
```
      The status code associated with the merging of an endpoint when issuing a response.
- Class com.amazonaws.services.pinpoint.model.EndpointLocation extends Object implements Serializable
  - Serialized Fields
    - city
```
String city
```
      The city where the endpoint is located.
    - country
```
String country
```
      The two-letter code for the country or region of the endpoint. Specified as an ISO 3166-1 alpha-2 code, such as "US" for the United States.
    - latitude
```
Double latitude
```
      The latitude of the endpoint location, rounded to one decimal place.
    - longitude
```
Double longitude
```
      The longitude of the endpoint location, rounded to one decimal place.
    - postalCode
```
String postalCode
```
      The postal code or zip code of the endpoint.
    - region
```
String region
```
      The region of the endpoint location. For example, in the United States, this corresponds to a state.
- Class com.amazonaws.services.pinpoint.model.EndpointMessageResult extends Object implements Serializable
  - Serialized Fields
    - address
```
String address
```
      Address that endpoint message was delivered to.
    - deliveryStatus
```
String deliveryStatus
```
      The delivery status of the message. Possible values: SUCCESS - The message was successfully delivered to the endpoint. TRANSIENT_FAILURE - A temporary error occurred. Amazon Pinpoint will attempt to deliver the message again later. FAILURE_PERMANENT - An error occurred when delivering the message to the endpoint. Amazon Pinpoint won't attempt to send the message again. TIMEOUT - The message couldn't be sent within the timeout period. QUIET_TIME - The local time for the endpoint was within the QuietTime for the campaign or app. DAILY_CAP - The endpoint has received the maximum number of messages it can receive within a 24-hour period. HOLDOUT - The endpoint was in a hold out treatment for the campaign. THROTTLED - Amazon Pinpoint throttled sending to this endpoint. EXPIRED - The endpoint address is expired. CAMPAIGN_CAP - The endpoint received the maximum number of messages allowed by the campaign. SERVICE_FAILURE - A service-level failure prevented Amazon Pinpoint from delivering the message. UNKNOWN - An unknown error occurred.
    - messageId
```
String messageId
```
      Unique message identifier associated with the message that was sent.
    - statusCode
```
Integer statusCode
```
      Downstream service status code.
    - statusMessage
```
String statusMessage
```
      Status message for message delivery.
    - updatedToken
```
String updatedToken
```
      If token was updated as part of delivery. (This is GCM Specific)
- Class com.amazonaws.services.pinpoint.model.EndpointRequest extends Object implements Serializable
  - Serialized Fields
    - address
```
String address
```
      The destination for messages that you send to this endpoint. The address varies by channel. For mobile push channels, use the token provided by the push notification service, such as the APNs device token or the 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.
    - attributes
```
Map<K,V> attributes
```
      Custom attributes that describe the endpoint by associating a name with an array of values. For example, an attribute named "interests" might have the values ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create a segment of users to engage with a messaging campaign. The following characters are not recommended in attribute names: # : ? \ /. The Amazon Pinpoint console does not display attributes that include these characters in the name. This limitation does not apply to attribute values.
    - channelType
```
String channelType
```
      The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU
    - demographic
```
EndpointDemographic demographic
```
      Demographic attributes for the endpoint.
    - effectiveDate
```
String effectiveDate
```
      The date and time when the endpoint was updated, shown in ISO 8601 format.
    - endpointStatus
```
String endpointStatus
```
      Unused.
    - location
```
EndpointLocation location
```
      The endpoint location attributes.
    - metrics
```
Map<K,V> metrics
```
      Custom metrics that your app reports to Amazon Pinpoint.
    - optOut
```
String optOut
```
      Indicates whether a user has opted out of receiving messages with one of the following values: ALL - User has opted out of all messages. NONE - Users has not opted out and receives all messages.
    - requestId
```
String requestId
```
      The unique ID for the most recent request to update the endpoint.
    - user
```
EndpointUser user
```
      Custom user-specific attributes that your app reports to Amazon Pinpoint.
- Class com.amazonaws.services.pinpoint.model.EndpointResponse extends Object implements Serializable
  - Serialized Fields
    - address
```
String address
```
      The address of the endpoint as provided by your push provider. For example, the DeviceToken or RegistrationId.
    - applicationId
```
String applicationId
```
      The ID of the application that is associated with the endpoint.
    - attributes
```
Map<K,V> attributes
```
      Custom attributes that describe the endpoint by associating a name with an array of values. For example, an attribute named "interests" might have the following values: ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create segments. The Amazon Pinpoint console can't display attribute names that include the following characters: hash/pound sign (#), colon (:), question mark (?), backslash (\), and forward slash (/). For this reason, you should avoid using these characters in the names of custom attributes.
    - channelType
```
String channelType
```
      The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU
    - cohortId
```
String cohortId
```
      A number from 0-99 that represents the cohort the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an app. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for a campaign.
    - creationDate
```
String creationDate
```
      The date and time when the endpoint was created, shown in ISO 8601 format.
    - demographic
```
EndpointDemographic demographic
```
      The endpoint demographic attributes.
    - effectiveDate
```
String effectiveDate
```
      The date and time when the endpoint was last updated, shown in ISO 8601 format.
    - endpointStatus
```
String endpointStatus
```
      Unused.
    - id
```
String id
```
      The unique ID that you assigned to the endpoint. The ID should be a globally unique identifier (GUID) to ensure that it doesn't conflict with other endpoint IDs associated with the application.
    - location
```
EndpointLocation location
```
      The endpoint location attributes.
    - metrics
```
Map<K,V> metrics
```
      Custom metrics that your app reports to Amazon Pinpoint.
    - optOut
```
String optOut
```
      Indicates whether a user has opted out of receiving messages with one of the following values: ALL - User has opted out of all messages. NONE - Users has not opted out and receives all messages.
    - requestId
```
String requestId
```
      The unique ID for the most recent request to update the endpoint.
    - user
```
EndpointUser user
```
      Custom user-specific attributes that your app reports to Amazon Pinpoint.
- Class com.amazonaws.services.pinpoint.model.EndpointSendConfiguration extends Object implements Serializable
  - Serialized Fields
    - bodyOverride
```
String bodyOverride
```
      Body override. If specified will override default body.
    - context
```
Map<K,V> context
```
      A map of custom attributes to attributes to be attached to the message for this address. This payload is added to the push notification's 'data.pinpoint' object or added to the email/sms delivery receipt event attributes.
    - rawContent
```
String rawContent
```
      The Raw JSON formatted string to be used as the payload. This value overrides the message.
    - substitutions
```
Map<K,V> substitutions
```
      A map of substitution values for the message to be merged with the DefaultMessage's substitutions. Substitutions on this map take precedence over the all other substitutions.
    - titleOverride
```
String titleOverride
```
      Title override. If specified will override default title if applicable.
- Class com.amazonaws.services.pinpoint.model.EndpointsResponse extends Object implements Serializable
  - Serialized Fields
    - item
```
List<E> item
```
      The list of endpoints.
- Class com.amazonaws.services.pinpoint.model.EndpointUser extends Object implements Serializable
  - Serialized Fields
    - userAttributes
```
Map<K,V> userAttributes
```
      Custom attributes that describe the user by associating a name with an array of values. For example, an attribute named "interests" might have the following values: ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create segments. The Amazon Pinpoint console can't display attribute names that include the following characters: hash/pound sign (#), colon (:), question mark (?), backslash (\), and forward slash (/). For this reason, you should avoid using these characters in the names of custom attributes.
    - userId
```
String userId
```
      The unique ID of the user.
- Class com.amazonaws.services.pinpoint.model.Event extends Object implements Serializable
  - Serialized Fields
    - appPackageName
```
String appPackageName
```
      The package name associated with the app that's recording the event.
    - appTitle
```
String appTitle
```
      The title of the app that's recording the event.
    - appVersionCode
```
String appVersionCode
```
      The version number of the app that's recording the event.
    - attributes
```
Map<K,V> attributes
```
      Custom attributes that are associated with the event you're adding or updating.
    - clientSdkVersion
```
String clientSdkVersion
```
      The version of the SDK that's running on the client device.
    - eventType
```
String eventType
```
      The name of the custom event that you're recording.
    - metrics
```
Map<K,V> metrics
```
      Custom metrics related to the event.
    - sdkName
```
String sdkName
```
      The name of the SDK that's being used to record the event.
    - session
```
Session session
```
      Information about the session in which the event occurred.
    - timestamp
```
String timestamp
```
      The date and time when the event occurred, in ISO 8601 format.
- Class com.amazonaws.services.pinpoint.model.EventDimensions extends Object implements Serializable
  - Serialized Fields
    - attributes
```
Map<K,V> attributes
```
      Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
    - eventType
```
SetDimension eventType
```
      The name of the event that causes the campaign to be sent. This can be a standard event type that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
    - metrics
```
Map<K,V> metrics
```
      Custom metrics that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
- Class com.amazonaws.services.pinpoint.model.EventItemResponse extends Object implements Serializable
  - Serialized Fields
    - message
```
String message
```
      A custom message that is associated with the processing of an event.
    - statusCode
```
Integer statusCode
```
      The status returned in the response as a result of processing the event. Possible values: 400 (for invalid events) and 202 (for events that were accepted).
- Class com.amazonaws.services.pinpoint.model.EventsBatch extends Object implements Serializable
  - Serialized Fields
    - endpoint
```
PublicEndpoint endpoint
```
      The PublicEndpoint attached to the EndpointId from the request.
    - events
```
Map<K,V> events
```
      An object that contains a set of events associated with the endpoint.
- Class com.amazonaws.services.pinpoint.model.EventsRequest extends Object implements Serializable
  - Serialized Fields
    - batchItem
```
Map<K,V> batchItem
```
      A batch of events to process. Each BatchItem consists of an endpoint ID as the key, and an EventsBatch object as the value.
- Class com.amazonaws.services.pinpoint.model.EventsResponse extends Object implements Serializable
  - Serialized Fields
    - results
```
Map<K,V> results
```
      A map that contains a multipart response for each endpoint. Each item in this object uses the endpoint ID as the key, and the item response as the value. If no item response exists, the value can also be one of the following: 202 (if the request was processed successfully) or 400 (if the payload was invalid, or required fields were missing).
- Class com.amazonaws.services.pinpoint.model.EventStream extends Object implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The ID of the application from which events should be published.
    - destinationStreamArn
```
String destinationStreamArn
```
      The Amazon Resource Name (ARN) of the Amazon Kinesis stream or Firehose delivery stream to which you want to publish events. Firehose ARN: arn:aws:firehose:REGION:ACCOUNT_ID:deliverystream/STREAM_NAME Kinesis ARN: arn:aws:kinesis:REGION:ACCOUNT_ID:stream/STREAM_NAME
    - externalId
```
String externalId
```
      (Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.
    - lastModifiedDate
```
String lastModifiedDate
```
      The date the event stream was last updated in ISO 8601 format.
    - lastUpdatedBy
```
String lastUpdatedBy
```
      The IAM user who last modified the event stream.
    - roleArn
```
String roleArn
```
      The IAM role that authorizes Amazon Pinpoint to publish events to the stream in your account.
- Class com.amazonaws.services.pinpoint.model.ExportJobRequest extends Object implements Serializable
  - Serialized Fields
    - roleArn
```
String roleArn
```
      The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that endpoints will be exported to.
    - s3UrlPrefix
```
String s3UrlPrefix
```
      A URL that points to the location within an Amazon S3 bucket that will receive the export. The location is typically a folder with multiple files. The URL should follow this format: s3://bucket-name/folder-name/ Amazon Pinpoint will export endpoints to this location.
    - segmentId
```
String segmentId
```
      The ID of the segment to export endpoints from. If not present, Amazon Pinpoint exports all of the endpoints that belong to the application.
    - segmentVersion
```
Integer segmentVersion
```
      The version of the segment to export if specified.
- Class com.amazonaws.services.pinpoint.model.ExportJobResource extends Object implements Serializable
  - Serialized Fields
    - roleArn
```
String roleArn
```
      The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that endpoints will be exported to.
    - s3UrlPrefix
```
String s3UrlPrefix
```
      A URL that points to the location within an Amazon S3 bucket that will receive the export. The location is typically a folder with multiple files. The URL should follow this format: s3://bucket-name/folder-name/ Amazon Pinpoint will export endpoints to this location.
    - segmentId
```
String segmentId
```
      The ID of the segment to export endpoints from. If not present, Amazon Pinpoint exports all of the endpoints that belong to the application.
    - segmentVersion
```
Integer segmentVersion
```
      The version of the segment to export if specified.
- Class com.amazonaws.services.pinpoint.model.ExportJobResponse extends Object implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of the application associated with the export job.
    - completedPieces
```
Integer completedPieces
```
      The number of pieces that have successfully completed as of the time of the request.
    - completionDate
```
String completionDate
```
      The date the job completed in ISO 8601 format.
    - creationDate
```
String creationDate
```
      The date the job was created in ISO 8601 format.
    - definition
```
ExportJobResource definition
```
      The export job settings.
    - failedPieces
```
Integer failedPieces
```
      The number of pieces that failed to be processed as of the time of the request.
    - failures
```
List<E> failures
```
      Provides up to 100 of the first failed entries for the job, if any exist.
    - id
```
String id
```
      The unique ID of the job.
    - jobStatus
```
String jobStatus
```
      The status of the job. Valid values: CREATED, INITIALIZING, PROCESSING, COMPLETING, COMPLETED, FAILING, FAILED The job status is FAILED if one or more pieces failed.
    - totalFailures
```
Integer totalFailures
```
      The number of endpoints that were not processed; for example, because of syntax errors.
    - totalPieces
```
Integer totalPieces
```
      The total number of pieces that must be processed to finish the job. Each piece is an approximately equal portion of the endpoints.
    - totalProcessed
```
Integer totalProcessed
```
      The number of endpoints that were processed by the job.
    - type
```
String type
```
      The job type. Will be 'EXPORT'.
- Class com.amazonaws.services.pinpoint.model.ExportJobsResponse extends Object implements Serializable
  - Serialized Fields
    - item
```
List<E> item
```
      A list of export jobs for the application.
    - nextToken
```
String nextToken
```
      The string that you use in a subsequent request to get the next page of results in a paginated response.
- Class com.amazonaws.services.pinpoint.model.ForbiddenException extends AmazonPinpointException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - requestID
```
String requestID
```
      The unique message body ID.
- Class com.amazonaws.services.pinpoint.model.GCMChannelRequest extends Object implements Serializable
  - Serialized Fields
    - apiKey
```
String apiKey
```
      Platform credential API key from Google.
    - enabled
```
Boolean enabled
```
      If the channel is enabled for sending messages.
- Class com.amazonaws.services.pinpoint.model.GCMChannelResponse extends Object implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The ID of the application to which the channel applies.
    - creationDate
```
String creationDate
```
      When was this segment created
    - credential
```
String credential
```
      The GCM API key from Google.
    - enabled
```
Boolean enabled
```
      If the channel is enabled for sending messages.
    - hasCredential
```
Boolean hasCredential
```
      Not used. Retained for backwards compatibility.
    - id
```
String id
```
      Channel ID. Not used. Present only for backwards compatibility.
    - isArchived
```
Boolean isArchived
```
      Is this channel archived
    - lastModifiedBy
```
String lastModifiedBy
```
      Who last updated this entry
    - lastModifiedDate
```
String lastModifiedDate
```
      Last date this was updated
    - platform
```
String platform
```
      The platform type. Will be GCM
    - version
```
Integer version
```
      Version of channel
- Class com.amazonaws.services.pinpoint.model.GCMMessage extends Object implements Serializable
  - Serialized Fields
    - action
```
String action
```
      The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL
    - body
```
String body
```
      The message body of the notification.
    - collapseKey
```
String collapseKey
```
      This parameter identifies a group of messages (e.g., with collapse_key: "Updates Available") that can be collapsed, so that only the last message gets sent when delivery can be resumed. This is intended to avoid sending too many of the same messages when the device comes back online or becomes active.
    - data
```
Map<K,V> data
```
      The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
    - iconReference
```
String iconReference
```
      The icon image name of the asset saved in your application.
    - imageIconUrl
```
String imageIconUrl
```
      The URL that points to an image used as the large icon to the notification content view.
    - imageUrl
```
String imageUrl
```
      The URL that points to an image used in the push notification.
    - priority
```
String priority
```
      The message priority. Amazon Pinpoint uses this value to set the FCM or GCM priority parameter when it sends the message. Accepts the following values: "Normal" - Messages might be delayed. Delivery is optimized for battery usage on the receiving device. Use normal priority unless immediate delivery is required. "High" - Messages are sent immediately and might wake a sleeping device. The equivalent values for APNs messages are "5" and "10". Amazon Pinpoint accepts these values here and converts them. For more information, see About FCM Messages in the Firebase documentation.
    - rawContent
```
String rawContent
```
      The Raw JSON formatted string to be used as the payload. This value overrides the message.
    - restrictedPackageName
```
String restrictedPackageName
```
      This parameter specifies the package name of the application where the registration tokens must match in order to receive the message.
    - silentPush
```
Boolean silentPush
```
      Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
    - smallImageIconUrl
```
String smallImageIconUrl
```
      The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view
    - sound
```
String sound
```
      Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/
    - substitutions
```
Map<K,V> substitutions
```
      Default message substitutions. Can be overridden by individual address substitutions.
    - timeToLive
```
Integer timeToLive
```
      The length of time (in seconds) that FCM or GCM stores and attempts to deliver the message. If unspecified, the value defaults to the maximum, which is 2,419,200 seconds (28 days). Amazon Pinpoint uses this value to set the FCM or GCM time_to_live parameter.
    - title
```
String title
```
      The message title that displays above the message on the user's device.
    - url
```
String url
```
      The URL to open in the user's mobile browser. Used if the value for Action is URL.
- Class com.amazonaws.services.pinpoint.model.GetAdmChannelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
- Class com.amazonaws.services.pinpoint.model.GetAdmChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - aDMChannelResponse
```
ADMChannelResponse aDMChannelResponse
```
- Class com.amazonaws.services.pinpoint.model.GetApnsChannelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
- Class com.amazonaws.services.pinpoint.model.GetApnsChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - aPNSChannelResponse
```
APNSChannelResponse aPNSChannelResponse
```
- Class com.amazonaws.services.pinpoint.model.GetApnsSandboxChannelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
- Class com.amazonaws.services.pinpoint.model.GetApnsSandboxChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - aPNSSandboxChannelResponse
```
APNSSandboxChannelResponse aPNSSandboxChannelResponse
```
- Class com.amazonaws.services.pinpoint.model.GetApnsVoipChannelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
- Class com.amazonaws.services.pinpoint.model.GetApnsVoipChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - aPNSVoipChannelResponse
```
APNSVoipChannelResponse aPNSVoipChannelResponse
```
- Class com.amazonaws.services.pinpoint.model.GetApnsVoipSandboxChannelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
- Class com.amazonaws.services.pinpoint.model.GetApnsVoipSandboxChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - aPNSVoipSandboxChannelResponse
```
APNSVoipSandboxChannelResponse aPNSVoipSandboxChannelResponse
```
- Class com.amazonaws.services.pinpoint.model.GetApplicationSettingsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
- Class com.amazonaws.services.pinpoint.model.GetApplicationSettingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - applicationSettingsResource
```
ApplicationSettingsResource applicationSettingsResource
```
- Class com.amazonaws.services.pinpoint.model.GetAppRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
- Class com.amazonaws.services.pinpoint.model.GetAppResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - applicationResponse
```
ApplicationResponse applicationResponse
```
- Class com.amazonaws.services.pinpoint.model.GetAppsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - pageSize
```
String pageSize
```
      The number of entries you want on each page in the response.
    - token
```
String token
```
      The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.
- Class com.amazonaws.services.pinpoint.model.GetAppsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - applicationsResponse
```
ApplicationsResponse applicationsResponse
```
- Class com.amazonaws.services.pinpoint.model.GetBaiduChannelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
- Class com.amazonaws.services.pinpoint.model.GetBaiduChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - baiduChannelResponse
```
BaiduChannelResponse baiduChannelResponse
```
- Class com.amazonaws.services.pinpoint.model.GetCampaignActivitiesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
    - campaignId
```
String campaignId
```
      The unique ID of the campaign.
    - pageSize
```
String pageSize
```
      The number of entries you want on each page in the response.
    - token
```
String token
```
      The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.
- Class com.amazonaws.services.pinpoint.model.GetCampaignActivitiesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - activitiesResponse
```
ActivitiesResponse activitiesResponse
```
- Class com.amazonaws.services.pinpoint.model.GetCampaignRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
    - campaignId
```
String campaignId
```
      The unique ID of the campaign.
- Class com.amazonaws.services.pinpoint.model.GetCampaignResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - campaignResponse
```
CampaignResponse campaignResponse
```
- Class com.amazonaws.services.pinpoint.model.GetCampaignsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
    - pageSize
```
String pageSize
```
      The number of entries you want on each page in the response.
    - token
```
String token
```
      The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.
- Class com.amazonaws.services.pinpoint.model.GetCampaignsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - campaignsResponse
```
CampaignsResponse campaignsResponse
```
- Class com.amazonaws.services.pinpoint.model.GetCampaignVersionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
    - campaignId
```
String campaignId
```
      The unique ID of the campaign.
    - version
```
String version
```
      The version of the campaign.
- Class com.amazonaws.services.pinpoint.model.GetCampaignVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - campaignResponse
```
CampaignResponse campaignResponse
```
- Class com.amazonaws.services.pinpoint.model.GetCampaignVersionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
    - campaignId
```
String campaignId
```
      The unique ID of the campaign.
    - pageSize
```
String pageSize
```
      The number of entries you want on each page in the response.
    - token
```
String token
```
      The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.
- Class com.amazonaws.services.pinpoint.model.GetCampaignVersionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - campaignsResponse
```
CampaignsResponse campaignsResponse
```
- Class com.amazonaws.services.pinpoint.model.GetChannelsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
- Class com.amazonaws.services.pinpoint.model.GetChannelsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - channelsResponse
```
ChannelsResponse channelsResponse
```
- Class com.amazonaws.services.pinpoint.model.GetEmailChannelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
- Class com.amazonaws.services.pinpoint.model.GetEmailChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - emailChannelResponse
```
EmailChannelResponse emailChannelResponse
```
- Class com.amazonaws.services.pinpoint.model.GetEndpointRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
    - endpointId
```
String endpointId
```
      The unique ID of the endpoint.
- Class com.amazonaws.services.pinpoint.model.GetEndpointResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - endpointResponse
```
EndpointResponse endpointResponse
```
- Class com.amazonaws.services.pinpoint.model.GetEventStreamRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
- Class com.amazonaws.services.pinpoint.model.GetEventStreamResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - eventStream
```
EventStream eventStream
```
- Class com.amazonaws.services.pinpoint.model.GetExportJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
    - jobId
```
String jobId
```
      The unique ID of the job.
- Class com.amazonaws.services.pinpoint.model.GetExportJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - exportJobResponse
```
ExportJobResponse exportJobResponse
```
- Class com.amazonaws.services.pinpoint.model.GetExportJobsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
    - pageSize
```
String pageSize
```
      The number of entries you want on each page in the response.
    - token
```
String token
```
      The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.
- Class com.amazonaws.services.pinpoint.model.GetExportJobsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - exportJobsResponse
```
ExportJobsResponse exportJobsResponse
```
- Class com.amazonaws.services.pinpoint.model.GetGcmChannelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
- Class com.amazonaws.services.pinpoint.model.GetGcmChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - gCMChannelResponse
```
GCMChannelResponse gCMChannelResponse
```
- Class com.amazonaws.services.pinpoint.model.GetImportJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
    - jobId
```
String jobId
```
      The unique ID of the job.
- Class com.amazonaws.services.pinpoint.model.GetImportJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - importJobResponse
```
ImportJobResponse importJobResponse
```
- Class com.amazonaws.services.pinpoint.model.GetImportJobsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
    - pageSize
```
String pageSize
```
      The number of entries you want on each page in the response.
    - token
```
String token
```
      The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.
- Class com.amazonaws.services.pinpoint.model.GetImportJobsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - importJobsResponse
```
ImportJobsResponse importJobsResponse
```
- Class com.amazonaws.services.pinpoint.model.GetSegmentExportJobsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
    - pageSize
```
String pageSize
```
      The number of entries you want on each page in the response.
    - segmentId
```
String segmentId
```
      The unique ID of the segment.
    - token
```
String token
```
      The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.
- Class com.amazonaws.services.pinpoint.model.GetSegmentExportJobsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - exportJobsResponse
```
ExportJobsResponse exportJobsResponse
```
- Class com.amazonaws.services.pinpoint.model.GetSegmentImportJobsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
    - pageSize
```
String pageSize
```
      The number of entries you want on each page in the response.
    - segmentId
```
String segmentId
```
      The unique ID of the segment.
    - token
```
String token
```
      The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.
- Class com.amazonaws.services.pinpoint.model.GetSegmentImportJobsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - importJobsResponse
```
ImportJobsResponse importJobsResponse
```
- Class com.amazonaws.services.pinpoint.model.GetSegmentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
    - segmentId
```
String segmentId
```
      The unique ID of the segment.
- Class com.amazonaws.services.pinpoint.model.GetSegmentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - segmentResponse
```
SegmentResponse segmentResponse
```
- Class com.amazonaws.services.pinpoint.model.GetSegmentsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
    - pageSize
```
String pageSize
```
      The number of entries you want on each page in the response.
    - token
```
String token
```
      The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.
- Class com.amazonaws.services.pinpoint.model.GetSegmentsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - segmentsResponse
```
SegmentsResponse segmentsResponse
```
- Class com.amazonaws.services.pinpoint.model.GetSegmentVersionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
    - segmentId
```
String segmentId
```
      The unique ID of the segment.
    - version
```
String version
```
      The segment version.
- Class com.amazonaws.services.pinpoint.model.GetSegmentVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - segmentResponse
```
SegmentResponse segmentResponse
```
- Class com.amazonaws.services.pinpoint.model.GetSegmentVersionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
    - pageSize
```
String pageSize
```
      The number of entries you want on each page in the response.
    - segmentId
```
String segmentId
```
      The unique ID of the segment.
    - token
```
String token
```
      The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.
- Class com.amazonaws.services.pinpoint.model.GetSegmentVersionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - segmentsResponse
```
SegmentsResponse segmentsResponse
```
- Class com.amazonaws.services.pinpoint.model.GetSmsChannelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
- Class com.amazonaws.services.pinpoint.model.GetSmsChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - sMSChannelResponse
```
SMSChannelResponse sMSChannelResponse
```
- Class com.amazonaws.services.pinpoint.model.GetUserEndpointsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
    - userId
```
String userId
```
      The unique ID of the user.
- Class com.amazonaws.services.pinpoint.model.GetUserEndpointsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - endpointsResponse
```
EndpointsResponse endpointsResponse
```
- Class com.amazonaws.services.pinpoint.model.GetVoiceChannelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
- Class com.amazonaws.services.pinpoint.model.GetVoiceChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - voiceChannelResponse
```
VoiceChannelResponse voiceChannelResponse
```
- Class com.amazonaws.services.pinpoint.model.GPSCoordinates extends Object implements Serializable
  - Serialized Fields
    - latitude
```
Double latitude
```
      Latitude
    - longitude
```
Double longitude
```
      Longitude
- Class com.amazonaws.services.pinpoint.model.GPSPointDimension extends Object implements Serializable
  - Serialized Fields
    - coordinates
```
GPSCoordinates coordinates
```
      Coordinate to measure distance from.
    - rangeInKilometers
```
Double rangeInKilometers
```
      Range in kilometers from the coordinate.
- Class com.amazonaws.services.pinpoint.model.ImportJobRequest extends Object implements Serializable
  - Serialized Fields
    - defineSegment
```
Boolean defineSegment
```
      Sets whether the endpoints create a segment when they are imported.
    - externalId
```
String externalId
```
      (Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.
    - format
```
String format
```
      The format of the files that contain the endpoint definitions. Valid values: CSV, JSON
    - registerEndpoints
```
Boolean registerEndpoints
```
      Sets whether the endpoints are registered with Amazon Pinpoint when they are imported.
    - roleArn
```
String roleArn
```
      The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that contains the endpoints to import.
    - s3Url
```
String s3Url
```
      The URL of the S3 bucket that contains the segment information to import. The location can be a folder or a single file. The URL should use the following format: s3://bucket-name/folder-name/file-name Amazon Pinpoint imports endpoints from this location and any subfolders it contains.
    - segmentId
```
String segmentId
```
      The ID of the segment to update if the import job is meant to update an existing segment.
    - segmentName
```
String segmentName
```
      A custom name for the segment created by the import job. Use if DefineSegment is true.
- Class com.amazonaws.services.pinpoint.model.ImportJobResource extends Object implements Serializable
  - Serialized Fields
    - defineSegment
```
Boolean defineSegment
```
      Sets whether the endpoints create a segment when they are imported.
    - externalId
```
String externalId
```
      (Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.
    - format
```
String format
```
      The format of the files that contain the endpoint definitions. Valid values: CSV, JSON
    - registerEndpoints
```
Boolean registerEndpoints
```
      Sets whether the endpoints are registered with Amazon Pinpoint when they are imported.
    - roleArn
```
String roleArn
```
      The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that contains the endpoints to import.
    - s3Url
```
String s3Url
```
      The URL of the S3 bucket that contains the segment information to import. The location can be a folder or a single file. The URL should use the following format: s3://bucket-name/folder-name/file-name Amazon Pinpoint imports endpoints from this location and any subfolders it contains.
    - segmentId
```
String segmentId
```
      The ID of the segment to update if the import job is meant to update an existing segment.
    - segmentName
```
String segmentName
```
      A custom name for the segment created by the import job. Use if DefineSegment is true.
- Class com.amazonaws.services.pinpoint.model.ImportJobResponse extends Object implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of the application to which the import job applies.
    - completedPieces
```
Integer completedPieces
```
      The number of pieces that have successfully imported as of the time of the request.
    - completionDate
```
String completionDate
```
      The date the import job completed in ISO 8601 format.
    - creationDate
```
String creationDate
```
      The date the import job was created in ISO 8601 format.
    - definition
```
ImportJobResource definition
```
      The import job settings.
    - failedPieces
```
Integer failedPieces
```
      The number of pieces that have failed to import as of the time of the request.
    - failures
```
List<E> failures
```
      Provides up to 100 of the first failed entries for the job, if any exist.
    - id
```
String id
```
      The unique ID of the import job.
    - jobStatus
```
String jobStatus
```
      The status of the import job. Valid values: CREATED, INITIALIZING, PROCESSING, COMPLETING, COMPLETED, FAILING, FAILED The job status is FAILED if one or more pieces failed to import.
    - totalFailures
```
Integer totalFailures
```
      The number of endpoints that failed to import; for example, because of syntax errors.
    - totalPieces
```
Integer totalPieces
```
      The total number of pieces that must be imported to finish the job. Each piece is an approximately equal portion of the endpoints to import.
    - totalProcessed
```
Integer totalProcessed
```
      The number of endpoints that were processed by the import job.
    - type
```
String type
```
      The job type. Will be Import.
- Class com.amazonaws.services.pinpoint.model.ImportJobsResponse extends Object implements Serializable
  - Serialized Fields
    - item
```
List<E> item
```
      A list of import jobs for the application.
    - nextToken
```
String nextToken
```
      The string that you use in a subsequent request to get the next page of results in a paginated response.
- Class com.amazonaws.services.pinpoint.model.InternalServerErrorException extends AmazonPinpointException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - requestID
```
String requestID
```
      The unique message body ID.
- Class com.amazonaws.services.pinpoint.model.ItemResponse extends Object implements Serializable
  - Serialized Fields
    - endpointItemResponse
```
EndpointItemResponse endpointItemResponse
```
      The response received after the endpoint was accepted.
    - eventsItemResponse
```
Map<K,V> eventsItemResponse
```
      A multipart response object that contains a key and value for each event ID in the request. In each object, the event ID is the key, and an EventItemResponse object is the value.
- Class com.amazonaws.services.pinpoint.model.ListTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
- Class com.amazonaws.services.pinpoint.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - tagsModel
```
TagsModel tagsModel
```
- Class com.amazonaws.services.pinpoint.model.Message extends Object implements Serializable
  - Serialized Fields
    - action
```
String action
```
      The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
    - body
```
String body
```
      The message body. Can include up to 140 characters.
    - imageIconUrl
```
String imageIconUrl
```
      The URL that points to the icon image for the push notification icon, for example, the app icon.
    - imageSmallIconUrl
```
String imageSmallIconUrl
```
      The URL that points to the small icon image for the push notification icon, for example, the app icon.
    - imageUrl
```
String imageUrl
```
      The URL that points to an image used in the push notification.
    - jsonBody
```
String jsonBody
```
      The JSON payload used for a silent push.
    - mediaUrl
```
String mediaUrl
```
      A URL that refers to the location of an image or video that you want to display in the push notification.
    - rawContent
```
String rawContent
```
      The Raw JSON formatted string to be used as the payload. This value overrides the message.
    - silentPush
```
Boolean silentPush
```
      Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
    - timeToLive
```
Integer timeToLive
```
      This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
    - title
```
String title
```
      The message title that displays above the message on the user's device.
    - url
```
String url
```
      The URL to open in the user's mobile browser. Used if the value for Action is URL.
- Class com.amazonaws.services.pinpoint.model.MessageBody extends Object implements Serializable
  - Serialized Fields
    - message
```
String message
```
      The error message that's returned from the API.
    - requestID
```
String requestID
```
      The unique message body ID.
- Class com.amazonaws.services.pinpoint.model.MessageConfiguration extends Object implements Serializable
  - Serialized Fields
    - aDMMessage
```
Message aDMMessage
```
      The message that the campaign delivers to ADM channels. Overrides the default message.
    - aPNSMessage
```
Message aPNSMessage
```
      The message that the campaign delivers to APNS channels. Overrides the default message.
    - baiduMessage
```
Message baiduMessage
```
      The message that the campaign delivers to Baidu channels. Overrides the default message.
    - defaultMessage
```
Message defaultMessage
```
      The default message for all channels.
    - emailMessage
```
CampaignEmailMessage emailMessage
```
      The email message configuration.
    - gCMMessage
```
Message gCMMessage
```
      The message that the campaign delivers to GCM channels. Overrides the default message.
    - sMSMessage
```
CampaignSmsMessage sMSMessage
```
      The SMS message configuration.
- Class com.amazonaws.services.pinpoint.model.MessageRequest extends Object implements Serializable
  - Serialized Fields
    - addresses
```
Map<K,V> addresses
```
      A map of key-value pairs, where each key is an address and each value is an AddressConfiguration object. An address can be a push notification token, a phone number, or an email address.
    - context
```
Map<K,V> context
```
      A map of custom attributes to attributes to be attached to the message. This payload is added to the push notification's 'data.pinpoint' object or added to the email/sms delivery receipt event attributes.
    - endpoints
```
Map<K,V> endpoints
```
      A map of key-value pairs, where each key is an endpoint ID and each value is an EndpointSendConfiguration object. Within an EndpointSendConfiguration object, you can tailor the message for an endpoint by specifying message overrides or substitutions.
    - messageConfiguration
```
DirectMessageConfiguration messageConfiguration
```
      Message configuration.
    - traceId
```
String traceId
```
      A unique ID that you can use to trace a message. This ID is visible to recipients.
- Class com.amazonaws.services.pinpoint.model.MessageResponse extends Object implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      Application id of the message.
    - endpointResult
```
Map<K,V> endpointResult
```
      A map containing a multi part response for each address, with the endpointId as the key and the result as the value.
    - requestId
```
String requestId
```
      Original request Id for which this message was delivered.
    - result
```
Map<K,V> result
```
      A map containing a multi part response for each address, with the address as the key(Email address, phone number or push token) and the result as the value.
- Class com.amazonaws.services.pinpoint.model.MessageResult extends Object implements Serializable
  - Serialized Fields
    - deliveryStatus
```
String deliveryStatus
```
      The delivery status of the message. Possible values: SUCCESS - The message was successfully delivered to the endpoint. TRANSIENT_FAILURE - A temporary error occurred. Amazon Pinpoint will attempt to deliver the message again later. FAILURE_PERMANENT - An error occurred when delivering the message to the endpoint. Amazon Pinpoint won't attempt to send the message again. TIMEOUT - The message couldn't be sent within the timeout period. QUIET_TIME - The local time for the endpoint was within the QuietTime for the campaign or app. DAILY_CAP - The endpoint has received the maximum number of messages it can receive within a 24-hour period. HOLDOUT - The endpoint was in a hold out treatment for the campaign. THROTTLED - Amazon Pinpoint throttled sending to this endpoint. EXPIRED - The endpoint address is expired. CAMPAIGN_CAP - The endpoint received the maximum number of messages allowed by the campaign. SERVICE_FAILURE - A service-level failure prevented Amazon Pinpoint from delivering the message. UNKNOWN - An unknown error occurred.
    - messageId
```
String messageId
```
      Unique message identifier associated with the message that was sent.
    - statusCode
```
Integer statusCode
```
      Downstream service status code.
    - statusMessage
```
String statusMessage
```
      Status message for message delivery.
    - updatedToken
```
String updatedToken
```
      If token was updated as part of delivery. (This is GCM Specific)
- Class com.amazonaws.services.pinpoint.model.MethodNotAllowedException extends AmazonPinpointException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - requestID
```
String requestID
```
      The unique message body ID.
- Class com.amazonaws.services.pinpoint.model.MetricDimension extends Object implements Serializable
  - Serialized Fields
    - comparisonOperator
```
String comparisonOperator
```
      The operator that you're using to compare metric values. Possible values: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, or EQUAL
    - value
```
Double value
```
      The value to be compared.
- Class com.amazonaws.services.pinpoint.model.NotFoundException extends AmazonPinpointException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - requestID
```
String requestID
```
      The unique message body ID.
- Class com.amazonaws.services.pinpoint.model.NumberValidateRequest extends Object implements Serializable
  - Serialized Fields
    - isoCountryCode
```
String isoCountryCode
```
      (Optional) The two-character ISO country code for the country or region where the phone number was originally registered.
    - phoneNumber
```
String phoneNumber
```
      The phone number to get information about. The phone number that you provide should include a country code. If the number doesn't include a valid country code, the operation might result in an error.
- Class com.amazonaws.services.pinpoint.model.NumberValidateResponse extends Object implements Serializable
  - Serialized Fields
    - carrier
```
String carrier
```
      The carrier or servive provider that the phone number is currently registered with.
    - city
```
String city
```
      The city where the phone number was originally registered.
    - cleansedPhoneNumberE164
```
String cleansedPhoneNumberE164
```
      The cleansed phone number, shown in E.164 format.
    - cleansedPhoneNumberNational
```
String cleansedPhoneNumberNational
```
      The cleansed phone number, shown in the local phone number format.
    - country
```
String country
```
      The country or region where the phone number was originally registered.
    - countryCodeIso2
```
String countryCodeIso2
```
      The two-character ISO code for the country or region where the phone number was originally registered.
    - countryCodeNumeric
```
String countryCodeNumeric
```
      The numeric code for the country or region where the phone number was originally registered.
    - county
```
String county
```
      The county where the phone number was originally registered.
    - originalCountryCodeIso2
```
String originalCountryCodeIso2
```
      The two-character code (in ISO 3166-1 alpha-2 format) for the country or region in the request body.
    - originalPhoneNumber
```
String originalPhoneNumber
```
      The phone number that you included in the request body.
    - phoneType
```
String phoneType
```
      A description of the phone type. Possible values are MOBILE, LANDLINE, VOIP, INVALID, PREPAID, and OTHER.
    - phoneTypeCode
```
Integer phoneTypeCode
```
      The phone type, represented by an integer. Possible values include 0 (MOBILE), 1 (LANDLINE), 2 (VOIP), 3 (INVALID), 4 (OTHER), and 5 (PREPAID).
    - timezone
```
String timezone
```
      The time zone for the location where the phone number was originally registered.
    - zipCode
```
String zipCode
```
      The postal code for the location where the phone number was originally registered.
- Class com.amazonaws.services.pinpoint.model.PhoneNumberValidateRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - numberValidateRequest
```
NumberValidateRequest numberValidateRequest
```
- Class com.amazonaws.services.pinpoint.model.PhoneNumberValidateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - numberValidateResponse
```
NumberValidateResponse numberValidateResponse
```
- Class com.amazonaws.services.pinpoint.model.PublicEndpoint extends Object implements Serializable
  - Serialized Fields
    - address
```
String address
```
      The unique identifier for the recipient. For example, an address could be a device token, email address, or mobile phone number.
    - attributes
```
Map<K,V> attributes
```
      Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create a segment.
    - channelType
```
String channelType
```
      The channel type. Valid values: APNS, GCM
    - demographic
```
EndpointDemographic demographic
```
      The endpoint demographic attributes.
    - effectiveDate
```
String effectiveDate
```
      The date and time when the endpoint was last updated, in ISO 8601 format.
    - endpointStatus
```
String endpointStatus
```
      The status of the endpoint. If the update fails, the value is INACTIVE. If the endpoint is updated successfully, the value is ACTIVE.
    - location
```
EndpointLocation location
```
      The endpoint location attributes.
    - metrics
```
Map<K,V> metrics
```
      Custom metrics that your app reports to Amazon Pinpoint.
    - optOut
```
String optOut
```
      Indicates whether a user has opted out of receiving messages with one of the following values: ALL - User has opted out of all messages. NONE - Users has not opted out and receives all messages.
    - requestId
```
String requestId
```
      A unique identifier that is generated each time the endpoint is updated.
    - user
```
EndpointUser user
```
      Custom user-specific attributes that your app reports to Amazon Pinpoint.
- Class com.amazonaws.services.pinpoint.model.PutEventsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
    - eventsRequest
```
EventsRequest eventsRequest
```
- Class com.amazonaws.services.pinpoint.model.PutEventsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - eventsResponse
```
EventsResponse eventsResponse
```
- Class com.amazonaws.services.pinpoint.model.PutEventStreamRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
    - writeEventStream
```
WriteEventStream writeEventStream
```
- Class com.amazonaws.services.pinpoint.model.PutEventStreamResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - eventStream
```
EventStream eventStream
```
- Class com.amazonaws.services.pinpoint.model.QuietTime extends Object implements Serializable
  - Serialized Fields
    - end
```
String end
```
      The time at which quiet time should end. The value that you specify has to be in HH:mm format, where HH is the hour in 24-hour format (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 start
```
      The time at which quiet time should begin. The value that you specify has to be in HH:mm format, where HH is the hour in 24-hour format (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.
- Class com.amazonaws.services.pinpoint.model.RawEmail extends Object implements Serializable
  - Serialized Fields
    - data
```
ByteBuffer data
```
      The raw email message itself. Then entire message must be base64-encoded.
- Class com.amazonaws.services.pinpoint.model.RecencyDimension extends Object implements Serializable
  - Serialized Fields
    - duration
```
String duration
```
      The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30
    - recencyType
```
String recencyType
```
      The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment.
- Class com.amazonaws.services.pinpoint.model.RemoveAttributesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
    - attributeType
```
String attributeType
```
      Type of attribute. Can be endpoint-custom-attributes, endpoint-custom-metrics, endpoint-user-attributes.
    - updateAttributesRequest
```
UpdateAttributesRequest updateAttributesRequest
```
- Class com.amazonaws.services.pinpoint.model.RemoveAttributesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - attributesResource
```
AttributesResource attributesResource
```
- Class com.amazonaws.services.pinpoint.model.Schedule extends Object implements Serializable
  - Serialized Fields
    - endTime
```
String endTime
```
      The scheduled time that the campaign ends in ISO 8601 format.
    - eventFilter
```
CampaignEventFilter eventFilter
```
      Defines the type of events that can trigger the campaign. Used when the Frequency is set to EVENT.
    - frequency
```
String frequency
```
      How often the campaign delivers messages. Valid values: ONCE HOURLY DAILY WEEKLY MONTHLY EVENT
    - isLocalTime
```
Boolean isLocalTime
```
      Indicates whether the campaign schedule takes effect according to each user's local time.
    - quietTime
```
QuietTime quietTime
```
      The default quiet time for the campaign. The campaign doesn't send messages to endpoints during the quiet time. Note: Make sure that your endpoints include the Demographics.Timezone attribute if you plan to enable a quiet time for your campaign. If your endpoints don't include this attribute, they'll receive the messages that you send them, even if quiet time is enabled. When you set up a campaign to use quiet time, the campaign doesn't send messages during the time range you specified, as long as all of the following are true: - The endpoint includes a valid Demographic.Timezone attribute. - The current time in the endpoint's time zone is later than or equal to the time specified in the QuietTime.Start attribute for the campaign. - The current time in the endpoint's time zone is earlier than or equal to the time specified in the QuietTime.End attribute for the campaign.
    - startTime
```
String startTime
```
      The scheduled time that the campaign begins in ISO 8601 format.
    - timezone
```
String timezone
```
      The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: 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 UTC-11
- Class com.amazonaws.services.pinpoint.model.SegmentBehaviors extends Object implements Serializable
  - Serialized Fields
    - recency
```
RecencyDimension recency
```
      The recency of use.
- Class com.amazonaws.services.pinpoint.model.SegmentDemographics extends Object implements Serializable
  - Serialized Fields
    - appVersion
```
SetDimension appVersion
```
      The app version criteria for the segment.
    - channel
```
SetDimension channel
```
      The channel criteria for the segment.
    - deviceType
```
SetDimension deviceType
```
      The device type criteria for the segment.
    - make
```
SetDimension make
```
      The device make criteria for the segment.
    - model
```
SetDimension model
```
      The device model criteria for the segment.
    - platform
```
SetDimension platform
```
      The device platform criteria for the segment.
- Class com.amazonaws.services.pinpoint.model.SegmentDimensions extends Object implements Serializable
  - Serialized Fields
    - attributes
```
Map<K,V> attributes
```
      Custom segment attributes.
    - behavior
```
SegmentBehaviors behavior
```
      The segment behaviors attributes.
    - demographic
```
SegmentDemographics demographic
```
      The segment demographics attributes.
    - location
```
SegmentLocation location
```
      The segment location attributes.
    - metrics
```
Map<K,V> metrics
```
      Custom segment metrics.
    - userAttributes
```
Map<K,V> userAttributes
```
      Custom segment user attributes.
- Class com.amazonaws.services.pinpoint.model.SegmentGroup extends Object implements Serializable
  - Serialized Fields
    - dimensions
```
List<E> dimensions
```
      List of dimensions to include or exclude.
    - sourceSegments
```
List<E> sourceSegments
```
      The base segment that you build your segment on. The source segment defines the starting "universe" of endpoints. When you add dimensions to the segment, it filters the source segment based on the dimensions that you specify. You can specify more than one dimensional segment. You can only specify one imported segment. NOTE: If you specify an imported segment for this attribute, the segment size estimate that appears in the Amazon Pinpoint console shows the size of the imported segment, without any filters applied to it.
    - sourceType
```
String sourceType
```
      Specify how to handle multiple source segments. For example, if you specify three source segments, should the resulting segment be based on any or all of the segments? Acceptable values: ANY or ALL.
    - type
```
String type
```
      Specify how to handle multiple segment dimensions. For example, if you specify three dimensions, should the resulting segment include endpoints that are matched by all, any, or none of the dimensions? Acceptable values: ALL, ANY, or NONE.
- Class com.amazonaws.services.pinpoint.model.SegmentGroupList extends Object implements Serializable
  - Serialized Fields
    - groups
```
List<E> groups
```
      A set of segment criteria to evaluate.
    - include
```
String include
```
      Specify how to handle multiple segment groups. For example, if the segment includes three segment groups, should the resulting segment include endpoints that are matched by all, any, or none of the segment groups you created. Acceptable values: ALL, ANY, or NONE.
- Class com.amazonaws.services.pinpoint.model.SegmentImportResource extends Object implements Serializable
  - Serialized Fields
    - channelCounts
```
Map<K,V> channelCounts
```
      The number of channel types in the imported segment.
    - externalId
```
String externalId
```
      (Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.
    - format
```
String format
```
      The format of the endpoint files that were imported to create this segment. Valid values: CSV, JSON
    - roleArn
```
String roleArn
```
      The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the endpoints in Amazon S3.
    - s3Url
```
String s3Url
```
      The URL of the S3 bucket that the segment was imported from.
    - size
```
Integer size
```
      The number of endpoints that were successfully imported to create this segment.
- Class com.amazonaws.services.pinpoint.model.SegmentLocation extends Object implements Serializable
  - Serialized Fields
    - country
```
SetDimension country
```
      The country or region, in ISO 3166-1 alpha-2 format.
    - gPSPoint
```
GPSPointDimension gPSPoint
```
      The GPS Point dimension.
- Class com.amazonaws.services.pinpoint.model.SegmentReference extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      A unique identifier for the segment.
    - version
```
Integer version
```
      If specified contains a specific version of the segment included.
- Class com.amazonaws.services.pinpoint.model.SegmentResponse extends Object implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The ID of the application that the segment applies to.
    - arn
```
String arn
```
      The arn for the segment.
    - creationDate
```
String creationDate
```
      The date and time when the segment was created.
    - dimensions
```
SegmentDimensions dimensions
```
      The segment dimensions attributes.
    - id
```
String id
```
      The unique segment ID.
    - importDefinition
```
SegmentImportResource importDefinition
```
      The import job settings.
    - lastModifiedDate
```
String lastModifiedDate
```
      The date and time when the segment was last modified.
    - name
```
String name
```
      The name of the segment.
    - segmentGroups
```
SegmentGroupList segmentGroups
```
      A segment group, which consists of zero or more source segments, plus dimensions that are applied to those source segments.
    - segmentType
```
String segmentType
```
      The segment type: DIMENSIONAL - A dynamic segment built from selection criteria based on endpoint data reported by your app. You create this type of segment by using the segment builder in the Amazon Pinpoint console or by making a POST request to the segments resource. IMPORT - A static segment built from an imported set of endpoint definitions. You create this type of segment by importing a segment in the Amazon Pinpoint console or by making a POST request to the jobs/import resource.
    - tags
```
Map<K,V> tags
```
      The Tags for the segment.
    - version
```
Integer version
```
      The segment version number.
- Class com.amazonaws.services.pinpoint.model.SegmentsResponse extends Object implements Serializable
  - Serialized Fields
    - item
```
List<E> item
```
      The list of segments.
    - nextToken
```
String nextToken
```
      An identifier used to retrieve the next page of results. The token is null if no additional pages exist.
- Class com.amazonaws.services.pinpoint.model.SendMessagesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
    - messageRequest
```
MessageRequest messageRequest
```
- Class com.amazonaws.services.pinpoint.model.SendMessagesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - messageResponse
```
MessageResponse messageResponse
```
- Class com.amazonaws.services.pinpoint.model.SendUsersMessageRequest extends Object implements Serializable
  - Serialized Fields
    - context
```
Map<K,V> context
```
      A map of custom attribute-value pairs. Amazon Pinpoint adds these attributes to the data.pinpoint object in the body of the push notification payload. Amazon Pinpoint also provides these attributes in the events that it generates for users-messages deliveries.
    - messageConfiguration
```
DirectMessageConfiguration messageConfiguration
```
      Message definitions for the default message and any messages that are tailored for specific channels.
    - traceId
```
String traceId
```
      A unique ID that you can use to trace a message. This ID is visible to recipients.
    - users
```
Map<K,V> users
```
      A map that associates user IDs with EndpointSendConfiguration objects. Within an EndpointSendConfiguration object, you can tailor the message for a user by specifying message overrides or substitutions.
- Class com.amazonaws.services.pinpoint.model.SendUsersMessageResponse extends Object implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of the Amazon Pinpoint project used to send the message.
    - requestId
```
String requestId
```
      The unique ID assigned to the users-messages request.
    - result
```
Map<K,V> result
```
      An object that shows the endpoints that were messaged for each user. The object provides a list of user IDs. For each user ID, it provides the endpoint IDs that were messaged. For each endpoint ID, it provides an EndpointMessageResult object.
- Class com.amazonaws.services.pinpoint.model.SendUsersMessagesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
    - sendUsersMessageRequest
```
SendUsersMessageRequest sendUsersMessageRequest
```
- Class com.amazonaws.services.pinpoint.model.SendUsersMessagesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - sendUsersMessageResponse
```
SendUsersMessageResponse sendUsersMessageResponse
```
- Class com.amazonaws.services.pinpoint.model.Session extends Object implements Serializable
  - Serialized Fields
    - duration
```
Integer duration
```
      The duration of the session, in milliseconds.
    - id
```
String id
```
      A unique identifier for the session.
    - startTimestamp
```
String startTimestamp
```
      The date and time when the session began.
    - stopTimestamp
```
String stopTimestamp
```
      The date and time when the session ended.
- Class com.amazonaws.services.pinpoint.model.SetDimension extends Object implements Serializable
  - Serialized Fields
    - dimensionType
```
String dimensionType
```
      The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
    - values
```
List<E> values
```
      The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.
- Class com.amazonaws.services.pinpoint.model.SimpleEmail extends Object implements Serializable
  - Serialized Fields
    - htmlPart
```
SimpleEmailPart htmlPart
```
      The content of the message, in HTML format. Use this for email clients that can process HTML. You can include clickable links, formatted text, and much more in an HTML message.
    - subject
```
SimpleEmailPart subject
```
      The subject of the message: A short summary of the content, which will appear in the recipient's inbox.
    - textPart
```
SimpleEmailPart textPart
```
      The content of the message, in text format. Use this for text-based email clients, or clients on high-latency networks (such as mobile devices).
- Class com.amazonaws.services.pinpoint.model.SimpleEmailPart extends Object implements Serializable
  - Serialized Fields
    - charset
```
String charset
```
      The character set of the content.
    - data
```
String data
```
      The textual data of the content.
- Class com.amazonaws.services.pinpoint.model.SMSChannelRequest extends Object implements Serializable
  - Serialized Fields
    - enabled
```
Boolean enabled
```
      If the channel is enabled for sending messages.
    - senderId
```
String senderId
```
      Sender identifier of your messages.
    - shortCode
```
String shortCode
```
      ShortCode registered with phone provider.
- Class com.amazonaws.services.pinpoint.model.SMSChannelResponse extends Object implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of the application to which the SMS channel belongs.
    - creationDate
```
String creationDate
```
      The date that the settings were last updated in ISO 8601 format.
    - enabled
```
Boolean enabled
```
      If the channel is enabled for sending messages.
    - hasCredential
```
Boolean hasCredential
```
      Not used. Retained for backwards compatibility.
    - id
```
String id
```
      Channel ID. Not used, only for backwards compatibility.
    - isArchived
```
Boolean isArchived
```
      Is this channel archived
    - lastModifiedBy
```
String lastModifiedBy
```
      Who last updated this entry
    - lastModifiedDate
```
String lastModifiedDate
```
      Last date this was updated
    - platform
```
String platform
```
      Platform type. Will be "SMS"
    - promotionalMessagesPerSecond
```
Integer promotionalMessagesPerSecond
```
      Promotional messages per second that can be sent
    - senderId
```
String senderId
```
      Sender identifier of your messages.
    - shortCode
```
String shortCode
```
      The short code registered with the phone provider.
    - transactionalMessagesPerSecond
```
Integer transactionalMessagesPerSecond
```
      Transactional messages per second that can be sent
    - version
```
Integer version
```
      Version of channel
- Class com.amazonaws.services.pinpoint.model.SMSMessage extends Object implements Serializable
  - Serialized Fields
    - body
```
String body
```
      The body of the SMS message.
    - keyword
```
String keyword
```
      The SMS program name that you provided to AWS Support when you requested your dedicated number.
    - messageType
```
String messageType
```
      Is this a transaction priority message or lower priority.
    - originationNumber
```
String originationNumber
```
      The phone number that the SMS message originates from. Specify one of the dedicated long codes or short codes that you requested from AWS Support and that is assigned to your account. If this attribute is not specified, Amazon Pinpoint randomly assigns a long code.
    - senderId
```
String senderId
```
      The sender ID that is shown as the message sender on the recipient's device. Support for sender IDs varies by country or region.
    - substitutions
```
Map<K,V> substitutions
```
      Default message substitutions. Can be overridden by individual address substitutions.
- Class com.amazonaws.services.pinpoint.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
    - tagsModel
```
TagsModel tagsModel
```
- Class com.amazonaws.services.pinpoint.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.pinpoint.model.TagsModel extends Object implements Serializable
  - Serialized Fields
    - tags
```
Map<K,V> tags
```
- Class com.amazonaws.services.pinpoint.model.TooManyRequestsException extends AmazonPinpointException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - requestID
```
String requestID
```
      The unique message body ID.
- Class com.amazonaws.services.pinpoint.model.TreatmentResource extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The unique treatment ID.
    - messageConfiguration
```
MessageConfiguration messageConfiguration
```
      The message configuration settings.
    - schedule
```
Schedule schedule
```
      The campaign schedule.
    - sizePercent
```
Integer sizePercent
```
      The allocated percentage of users for this treatment.
    - state
```
CampaignState state
```
      The treatment status.
    - treatmentDescription
```
String treatmentDescription
```
      A custom description for the treatment.
    - treatmentName
```
String treatmentName
```
      The custom name of a variation of the campaign used for A/B testing.
- Class com.amazonaws.services.pinpoint.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
    - tagKeys
```
List<E> tagKeys
```
      The key(s) of tag to be deleted
- Class com.amazonaws.services.pinpoint.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.pinpoint.model.UpdateAdmChannelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - aDMChannelRequest
```
ADMChannelRequest aDMChannelRequest
```
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
- Class com.amazonaws.services.pinpoint.model.UpdateAdmChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - aDMChannelResponse
```
ADMChannelResponse aDMChannelResponse
```
- Class com.amazonaws.services.pinpoint.model.UpdateApnsChannelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - aPNSChannelRequest
```
APNSChannelRequest aPNSChannelRequest
```
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
- Class com.amazonaws.services.pinpoint.model.UpdateApnsChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - aPNSChannelResponse
```
APNSChannelResponse aPNSChannelResponse
```
- Class com.amazonaws.services.pinpoint.model.UpdateApnsSandboxChannelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - aPNSSandboxChannelRequest
```
APNSSandboxChannelRequest aPNSSandboxChannelRequest
```
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
- Class com.amazonaws.services.pinpoint.model.UpdateApnsSandboxChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - aPNSSandboxChannelResponse
```
APNSSandboxChannelResponse aPNSSandboxChannelResponse
```
- Class com.amazonaws.services.pinpoint.model.UpdateApnsVoipChannelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - aPNSVoipChannelRequest
```
APNSVoipChannelRequest aPNSVoipChannelRequest
```
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
- Class com.amazonaws.services.pinpoint.model.UpdateApnsVoipChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - aPNSVoipChannelResponse
```
APNSVoipChannelResponse aPNSVoipChannelResponse
```
- Class com.amazonaws.services.pinpoint.model.UpdateApnsVoipSandboxChannelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - aPNSVoipSandboxChannelRequest
```
APNSVoipSandboxChannelRequest aPNSVoipSandboxChannelRequest
```
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
- Class com.amazonaws.services.pinpoint.model.UpdateApnsVoipSandboxChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - aPNSVoipSandboxChannelResponse
```
APNSVoipSandboxChannelResponse aPNSVoipSandboxChannelResponse
```
- Class com.amazonaws.services.pinpoint.model.UpdateApplicationSettingsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
    - writeApplicationSettingsRequest
```
WriteApplicationSettingsRequest writeApplicationSettingsRequest
```
- Class com.amazonaws.services.pinpoint.model.UpdateApplicationSettingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - applicationSettingsResource
```
ApplicationSettingsResource applicationSettingsResource
```
- Class com.amazonaws.services.pinpoint.model.UpdateAttributesRequest extends Object implements Serializable
  - Serialized Fields
    - blacklist
```
List<E> blacklist
```
      The GLOB wildcard for removing the attributes in the application
- Class com.amazonaws.services.pinpoint.model.UpdateBaiduChannelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
    - baiduChannelRequest
```
BaiduChannelRequest baiduChannelRequest
```
- Class com.amazonaws.services.pinpoint.model.UpdateBaiduChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - baiduChannelResponse
```
BaiduChannelResponse baiduChannelResponse
```
- Class com.amazonaws.services.pinpoint.model.UpdateCampaignRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
    - campaignId
```
String campaignId
```
      The unique ID of the campaign.
    - writeCampaignRequest
```
WriteCampaignRequest writeCampaignRequest
```
- Class com.amazonaws.services.pinpoint.model.UpdateCampaignResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - campaignResponse
```
CampaignResponse campaignResponse
```
- Class com.amazonaws.services.pinpoint.model.UpdateEmailChannelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
    - emailChannelRequest
```
EmailChannelRequest emailChannelRequest
```
- Class com.amazonaws.services.pinpoint.model.UpdateEmailChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - emailChannelResponse
```
EmailChannelResponse emailChannelResponse
```
- Class com.amazonaws.services.pinpoint.model.UpdateEndpointRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
    - endpointId
```
String endpointId
```
      The unique ID of the endpoint.
    - endpointRequest
```
EndpointRequest endpointRequest
```
- Class com.amazonaws.services.pinpoint.model.UpdateEndpointResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - messageBody
```
MessageBody messageBody
```
- Class com.amazonaws.services.pinpoint.model.UpdateEndpointsBatchRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
    - endpointBatchRequest
```
EndpointBatchRequest endpointBatchRequest
```
- Class com.amazonaws.services.pinpoint.model.UpdateEndpointsBatchResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - messageBody
```
MessageBody messageBody
```
- Class com.amazonaws.services.pinpoint.model.UpdateGcmChannelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
    - gCMChannelRequest
```
GCMChannelRequest gCMChannelRequest
```
- Class com.amazonaws.services.pinpoint.model.UpdateGcmChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - gCMChannelResponse
```
GCMChannelResponse gCMChannelResponse
```
- Class com.amazonaws.services.pinpoint.model.UpdateSegmentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
    - segmentId
```
String segmentId
```
      The unique ID of the segment.
    - writeSegmentRequest
```
WriteSegmentRequest writeSegmentRequest
```
- Class com.amazonaws.services.pinpoint.model.UpdateSegmentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - segmentResponse
```
SegmentResponse segmentResponse
```
- Class com.amazonaws.services.pinpoint.model.UpdateSmsChannelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
    - sMSChannelRequest
```
SMSChannelRequest sMSChannelRequest
```
- Class com.amazonaws.services.pinpoint.model.UpdateSmsChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - sMSChannelResponse
```
SMSChannelResponse sMSChannelResponse
```
- Class com.amazonaws.services.pinpoint.model.UpdateVoiceChannelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The unique ID of your Amazon Pinpoint application.
    - voiceChannelRequest
```
VoiceChannelRequest voiceChannelRequest
```
- Class com.amazonaws.services.pinpoint.model.UpdateVoiceChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - voiceChannelResponse
```
VoiceChannelResponse voiceChannelResponse
```
- Class com.amazonaws.services.pinpoint.model.VoiceChannelRequest extends Object implements Serializable
  - Serialized Fields
    - enabled
```
Boolean enabled
```
      If the channel is enabled for sending messages.
- Class com.amazonaws.services.pinpoint.model.VoiceChannelResponse extends Object implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      Application id
    - creationDate
```
String creationDate
```
      The date that the settings were last updated in ISO 8601 format.
    - enabled
```
Boolean enabled
```
      If the channel is enabled for sending messages.
    - hasCredential
```
Boolean hasCredential
```
    - id
```
String id
```
      Channel ID. Not used, only for backwards compatibility.
    - isArchived
```
Boolean isArchived
```
      Is this channel archived
    - lastModifiedBy
```
String lastModifiedBy
```
      Who made the last change
    - lastModifiedDate
```
String lastModifiedDate
```
      Last date this was updated
    - platform
```
String platform
```
      Platform type. Will be "Voice"
    - version
```
Integer version
```
      Version of channel
- Class com.amazonaws.services.pinpoint.model.VoiceMessage extends Object implements Serializable
  - Serialized Fields
    - body
```
String body
```
      The message body of the notification, the email body or the text message.
    - languageCode
```
String languageCode
```
      Language of sent message
    - originationNumber
```
String originationNumber
```
      Is the number from the pool or messaging service to send from.
    - substitutions
```
Map<K,V> substitutions
```
      Default message substitutions. Can be overridden by individual address substitutions.
    - voiceId
```
String voiceId
```
      Voice ID of sent message.
- Class com.amazonaws.services.pinpoint.model.WriteApplicationSettingsRequest extends Object implements Serializable
  - Serialized Fields
    - campaignHook
```
CampaignHook campaignHook
```
      Default campaign hook information.
    - cloudWatchMetricsEnabled
```
Boolean cloudWatchMetricsEnabled
```
      The CloudWatchMetrics settings for the app.
    - limits
```
CampaignLimits limits
```
      The limits that apply to each campaign in the project by default. Campaigns can also have their own limits, which override the settings at the project level.
    - quietTime
```
QuietTime quietTime
```
      The default quiet time for the app. Campaigns in the app don't send messages to endpoints during the quiet time. Note: Make sure that your endpoints include the Demographics.Timezone attribute if you plan to enable a quiet time for your app. If your endpoints don't include this attribute, they'll receive the messages that you send them, even if quiet time is enabled. When you set up an app to use quiet time, campaigns in that app don't send messages during the time range you specified, as long as all of the following are true: - The endpoint includes a valid Demographic.Timezone attribute. - The current time in the endpoint's time zone is later than or equal to the time specified in the QuietTime.Start attribute for the app (or campaign, if applicable). - The current time in the endpoint's time zone is earlier than or equal to the time specified in the QuietTime.End attribute for the app (or campaign, if applicable). Individual campaigns within the app can have their own quiet time settings, which override the quiet time settings at the app level.
- Class com.amazonaws.services.pinpoint.model.WriteCampaignRequest extends Object implements Serializable
  - Serialized Fields
    - additionalTreatments
```
List<E> additionalTreatments
```
      Treatments that are defined in addition to the default treatment.
    - description
```
String description
```
      A description of the campaign.
    - holdoutPercent
```
Integer holdoutPercent
```
      The allocated percentage of end users who will not receive messages from this campaign.
    - hook
```
CampaignHook hook
```
      Campaign hook information.
    - isPaused
```
Boolean isPaused
```
      Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.
    - limits
```
CampaignLimits limits
```
      The campaign limits settings.
    - messageConfiguration
```
MessageConfiguration messageConfiguration
```
      The message configuration settings.
    - name
```
String name
```
      The custom name of the campaign.
    - schedule
```
Schedule schedule
```
      The campaign schedule.
    - segmentId
```
String segmentId
```
      The ID of the segment to which the campaign sends messages.
    - segmentVersion
```
Integer segmentVersion
```
      The version of the segment to which the campaign sends messages.
    - tags
```
Map<K,V> tags
```
      The Tags for the campaign.
    - treatmentDescription
```
String treatmentDescription
```
      A custom description for the treatment.
    - treatmentName
```
String treatmentName
```
      The custom name of a variation of the campaign used for A/B testing.
- Class com.amazonaws.services.pinpoint.model.WriteEventStream extends Object implements Serializable
  - Serialized Fields
    - destinationStreamArn
```
String destinationStreamArn
```
      The Amazon Resource Name (ARN) of the Amazon Kinesis stream or Firehose delivery stream to which you want to publish events. Firehose ARN: arn:aws:firehose:REGION:ACCOUNT_ID:deliverystream/STREAM_NAME Kinesis ARN: arn:aws:kinesis:REGION:ACCOUNT_ID:stream/STREAM_NAME
    - roleArn
```
String roleArn
```
      The IAM role that authorizes Amazon Pinpoint to publish events to the stream in your account.
- Class com.amazonaws.services.pinpoint.model.WriteSegmentRequest extends Object implements Serializable
  - Serialized Fields
    - dimensions
```
SegmentDimensions dimensions
```
      The segment dimensions attributes.
    - name
```
String name
```
      The name of segment
    - segmentGroups
```
SegmentGroupList segmentGroups
```
      A segment group, which consists of zero or more source segments, plus dimensions that are applied to those source segments. Your request can only include one segment group. Your request can include either a SegmentGroups object or a Dimensions object, but not both.
    - tags
```
Map<K,V> tags
```
      The Tags for the segments.
- Class com.amazonaws.services.pinpoint.model.WriteTreatmentResource extends Object implements Serializable
  - Serialized Fields
    - messageConfiguration
```
MessageConfiguration messageConfiguration
```
      The message configuration settings.
    - schedule
```
Schedule schedule
```
      The campaign schedule.
    - sizePercent
```
Integer sizePercent
```
      The allocated percentage of users for this treatment.
    - treatmentDescription
```
String treatmentDescription
```
      A custom description for the treatment.
    - treatmentName
```
String treatmentName
```
      The custom name of a variation of the campaign used for A/B testing.

Serialized Form

Package com.amazonaws.services.pinpoint.model

Class com.amazonaws.services.pinpoint.model.ActivitiesResponse extends Object implements Serializable

Serialized Fields

item

nextToken

Class com.amazonaws.services.pinpoint.model.ActivityResponse extends Object implements Serializable

Serialized Fields

applicationId

campaignId

end

id

result

scheduledStart

start

state

successfulEndpointCount

timezonesCompletedCount

timezonesTotalCount

totalEndpointCount

treatmentId

Class com.amazonaws.services.pinpoint.model.AddressConfiguration extends Object implements Serializable

Serialized Fields

bodyOverride

channelType

context

rawContent

substitutions

titleOverride

Class com.amazonaws.services.pinpoint.model.ADMChannelRequest extends Object implements Serializable

Serialized Fields

clientId

clientSecret

enabled

Class com.amazonaws.services.pinpoint.model.ADMChannelResponse extends Object implements Serializable

Serialized Fields

applicationId

creationDate

enabled

hasCredential

id

isArchived

lastModifiedBy

lastModifiedDate

platform

version

Class com.amazonaws.services.pinpoint.model.ADMMessage extends Object implements Serializable

Serialized Fields

action

body

consolidationKey

data

expiresAfter

iconReference

imageIconUrl

imageUrl

mD5

rawContent

silentPush

smallImageIconUrl

sound

substitutions

title

url

Class com.amazonaws.services.pinpoint.model.AmazonPinpointException extends AmazonServiceException implements Serializable

Class com.amazonaws.services.pinpoint.model.APNSChannelRequest extends Object implements Serializable

Serialized Fields

bundleId

certificate

defaultAuthenticationMethod

enabled

privateKey

teamId

tokenKey

tokenKeyId

Class com.amazonaws.services.pinpoint.model.APNSChannelResponse extends Object implements Serializable

Serialized Fields

applicationId

creationDate

defaultAuthenticationMethod