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

rawContent

String rawContent

The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message.

silentPush

Boolean silentPush

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

sound

String sound

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

substitutions

Map<K,V> substitutions

The default message variables to use in the notification message. You can override these default variables with individual address variables.

threadId

String threadId

The key that represents your app-specific identifier for grouping notifications. If you provide a Notification Content app extension, you can use this value to group your notifications together.

timeToLive

Integer timeToLive

The amount of time, in seconds, that APNs should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If this value is 0, APNs treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

Amazon Pinpoint specifies this value in the apns-expiration request header when it sends the notification message to APNs.

title

String title

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

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

Serialized Fields
- bundleId
```
String bundleId
```
  The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.
- certificate
```
String certificate
```
  The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate.
- defaultAuthenticationMethod
```
String defaultAuthenticationMethod
```
  The default authentication method that you want Amazon Pinpoint to use when authenticating with the APNs sandbox environment, key or certificate.
- enabled
```
Boolean enabled
```
  Specifies whether to enable the APNs sandbox channel for the application.
- privateKey
```
String privateKey
```
  The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment.
- teamId
```
String teamId
```
  The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.
- tokenKey
```
String tokenKey
```
  The authentication key to use for APNs tokens.
- tokenKeyId
```
String tokenKeyId
```
  The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs tokens.

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

Serialized Fields
- applicationId
```
String applicationId
```
  The unique identifier for the application that the APNs sandbox channel applies to.
- creationDate
```
String creationDate
```
  The date and time when the APNs sandbox channel was enabled.
- defaultAuthenticationMethod
```
String defaultAuthenticationMethod
```
  The default authentication method that Amazon Pinpoint uses to authenticate with the APNs sandbox environment for this channel, key or certificate.
- enabled
```
Boolean enabled
```
  Specifies whether the APNs sandbox channel is enabled for the application.
- hasCredential
```
Boolean hasCredential
```
  (Not used) This property is retained only for backward compatibility.
- hasTokenKey
```
Boolean hasTokenKey
```
  Specifies whether the APNs sandbox channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.
- id
```
String id
```
  (Deprecated) An identifier for the APNs sandbox channel. This property is retained only for backward compatibility.
- isArchived
```
Boolean isArchived
```
  Specifies whether the APNs sandbox channel is archived.
- lastModifiedBy
```
String lastModifiedBy
```
  The user who last modified the APNs sandbox channel.
- lastModifiedDate
```
String lastModifiedDate
```
  The date and time when the APNs sandbox channel was last modified.
- platform
```
String platform
```
  The type of messaging or notification platform for the channel. For the APNs sandbox channel, this value is APNS_SANDBOX.
- version
```
Integer version
```
  The current version of the APNs sandbox channel.

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

Serialized Fields
- bundleId
```
String bundleId
```
  The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.
- certificate
```
String certificate
```
  The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate.
- defaultAuthenticationMethod
```
String defaultAuthenticationMethod
```
  The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate.
- enabled
```
Boolean enabled
```
  Specifies whether to enable the APNs VoIP channel for the application.
- privateKey
```
String privateKey
```
  The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.
- teamId
```
String teamId
```
  The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.
- tokenKey
```
String tokenKey
```
  The authentication key to use for APNs tokens.
- tokenKeyId
```
String tokenKeyId
```
  The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with APNs by using APNs tokens.

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

Serialized Fields
- applicationId
```
String applicationId
```
  The unique identifier for the application that the APNs VoIP channel applies to.
- creationDate
```
String creationDate
```
  The date and time when the APNs VoIP channel was enabled.
- defaultAuthenticationMethod
```
String defaultAuthenticationMethod
```
  The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate.
- enabled
```
Boolean enabled
```
  Specifies whether the APNs VoIP channel is enabled for the application.
- hasCredential
```
Boolean hasCredential
```
  (Not used) This property is retained only for backward compatibility.
- hasTokenKey
```
Boolean hasTokenKey
```
  Specifies whether the APNs VoIP channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.
- id
```
String id
```
  (Deprecated) An identifier for the APNs VoIP channel. This property is retained only for backward compatibility.
- isArchived
```
Boolean isArchived
```
  Specifies whether the APNs VoIP channel is archived.
- lastModifiedBy
```
String lastModifiedBy
```
  The user who last modified the APNs VoIP channel.
- lastModifiedDate
```
String lastModifiedDate
```
  The date and time when the APNs VoIP channel was last modified.
- platform
```
String platform
```
  The type of messaging or notification platform for the channel. For the APNs VoIP channel, this value is APNS_VOIP.
- version
```
Integer version
```
  The current version of the APNs VoIP channel.

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

Serialized Fields
- bundleId
```
String bundleId
```
  The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.
- certificate
```
String certificate
```
  The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate.
- defaultAuthenticationMethod
```
String defaultAuthenticationMethod
```
  The default authentication method that you want Amazon Pinpoint to use when authenticating with the APNs sandbox environment for this channel, key or certificate.
- enabled
```
Boolean enabled
```
  Specifies whether the APNs VoIP sandbox channel is enabled for the application.
- privateKey
```
String privateKey
```
  The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment.
- teamId
```
String teamId
```
  The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.
- tokenKey
```
String tokenKey
```
  The authentication key to use for APNs tokens.
- tokenKeyId
```
String tokenKeyId
```
  The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs tokens.

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

Serialized Fields
- applicationId
```
String applicationId
```
  The unique identifier for the application that the APNs VoIP sandbox channel applies to.
- creationDate
```
String creationDate
```
  The date and time when the APNs VoIP sandbox channel was enabled.
- defaultAuthenticationMethod
```
String defaultAuthenticationMethod
```
  The default authentication method that Amazon Pinpoint uses to authenticate with the APNs sandbox environment for this channel, key or certificate.
- enabled
```
Boolean enabled
```
  Specifies whether the APNs VoIP sandbox channel is enabled for the application.
- hasCredential
```
Boolean hasCredential
```
  (Not used) This property is retained only for backward compatibility.
- hasTokenKey
```
Boolean hasTokenKey
```
  Specifies whether the APNs VoIP sandbox channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.
- id
```
String id
```
  (Deprecated) An identifier for the APNs VoIP sandbox channel. This property is retained only for backward compatibility.
- isArchived
```
Boolean isArchived
```
  Specifies whether the APNs VoIP sandbox channel is archived.
- lastModifiedBy
```
String lastModifiedBy
```
  The user who last modified the APNs VoIP sandbox channel.
- lastModifiedDate
```
String lastModifiedDate
```
  The date and time when the APNs VoIP sandbox channel was last modified.
- platform
```
String platform
```
  The type of messaging or notification platform for the channel. For the APNs VoIP sandbox channel, this value is APNS_VOIP_SANDBOX.
- version
```
Integer version
```
  The current version of the APNs VoIP sandbox channel.

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

Serialized Fields
- arn
```
String arn
```
  The Amazon Resource Name (ARN) of the application.
- id
```
String id
```
  The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
- name
```
String name
```
  The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console.
- tags
```
Map<K,V> tags
```
  A string-to-string map of key-value pairs that identifies the tags that are associated with the application. Each tag consists of a required tag key and an associated tag value.

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

Serialized Fields
- applicationId
```
String applicationId
```
  The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
- campaignHook
```
CampaignHook campaignHook
```
  The settings for the AWS Lambda function to use by default as a code hook for campaigns in the application.
- lastModifiedDate
```
String lastModifiedDate
```
  The date and time, in ISO 8601 format, when the application's settings were last modified.
- limits
```
CampaignLimits limits
```
  The default sending limits for campaigns in the application.
- quietTime
```
QuietTime quietTime
```
  The default quiet time for campaigns in the application. Quiet time is a specific time range when campaigns don't send messages to endpoints, if all the following conditions are met:
  - The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
  - The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application (or a campaign that has custom quiet time settings).
  - The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application (or a campaign that has custom quiet time settings).
  If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign, even if quiet time is enabled.

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

Serialized Fields
- item
```
List<E> item
```
  An array of responses, one for each application that was returned.
- nextToken
```
String nextToken
```
  The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

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

Serialized Fields
- attributeType
```
String attributeType
```
  The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
- values
```
List<E> values
```
  The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

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

Serialized Fields
- applicationId
```
String applicationId
```
  The unique identifier for the application.
- attributeType
```
String attributeType
```
  The type of attribute or attributes that were removed from the endpoints. Valid values are:
  - endpoint-custom-attributes - Custom attributes that describe endpoints
  - endpoint-custom-metrics - Custom metrics that your app reports to Amazon Pinpoint for endpoints
  - endpoint-user-attributes - Custom attributes that describe users
- attributes
```
List<E> attributes
```
  An array that specifies the names of the attributes that were removed from the endpoints.

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

serialVersionUID:: 1L

Serialized Fields
- requestID
```
String requestID
```
  The unique identifier for the request or response.

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

Serialized Fields
- apiKey
```
String apiKey
```
  The API key that you received from the Baidu Cloud Push service to communicate with the service.
- enabled
```
Boolean enabled
```
  Specifies whether to enable the Baidu channel for the application.
- secretKey
```
String secretKey
```
  The secret key that you received from the Baidu Cloud Push service to communicate with the service.

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

Serialized Fields
- applicationId
```
String applicationId
```
  The unique identifier for the application that the Baidu channel applies to.
- creationDate
```
String creationDate
```
  The date and time when the Baidu channel was enabled.
- credential
```
String credential
```
  The API key that you received from the Baidu Cloud Push service to communicate with the service.
- enabled
```
Boolean enabled
```
  Specifies whether the Baidu channel is enabled for the application.
- hasCredential
```
Boolean hasCredential
```
  (Not used) This property is retained only for backward compatibility.
- id
```
String id
```
  (Deprecated) An identifier for the Baidu channel. This property is retained only for backward compatibility.
- isArchived
```
Boolean isArchived
```
  Specifies whether the Baidu channel is archived.
- lastModifiedBy
```
String lastModifiedBy
```
  The user who last modified the Baidu channel.
- lastModifiedDate
```
String lastModifiedDate
```
  The date and time when the Baidu channel was last modified.
- platform
```
String platform
```
  The type of messaging or notification platform for the channel. For the Baidu channel, this value is BAIDU.
- version
```
Integer version
```
  The current version of the Baidu channel.

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

Serialized Fields
- action
```
String action
```
  The action to occur if the recipient taps the push notification. Valid values are:
  - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
  - DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
  - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
- body
```
String body
```
  The body of the notification message.
- data
```
Map<K,V> data
```
  The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
- iconReference
```
String iconReference
```
  The icon image name of the asset saved in your app.
- imageIconUrl
```
String imageIconUrl
```
  The URL of the large icon image to display in the content view of the push notification.
- imageUrl
```
String imageUrl
```
  The URL of an image to display in the push notification.
- rawContent
```
String rawContent
```
  The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message.
- silentPush
```
Boolean silentPush
```
  Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.
- smallImageIconUrl
```
String smallImageIconUrl
```
  The URL of the small icon image to display in the status bar and the content view of the push notification.
- sound
```
String sound
```
  The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
- substitutions
```
Map<K,V> substitutions
```
  The default message variables to use in the notification message. You can override the default variables with individual address variables.
- timeToLive
```
Integer timeToLive
```
  The amount of time, in seconds, that the Baidu Cloud Push service should store the message if the recipient's device is offline. The default value and maximum supported time is 604,800 seconds (7 days).
- title
```
String title
```
  The title to display above the notification message on the recipient's device.
- url
```
String url
```
  The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

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

Serialized Fields
- body
```
String body
```
  The body of the email for recipients whose email clients don't support HTML content.
- fromAddress
```
String fromAddress
```
  The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
- htmlBody
```
String htmlBody
```
  The body of the email, in HTML format, for recipients whose email clients support HTML content.
- title
```
String title
```
  The subject line, or title, of the email.

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

Serialized Fields
- dimensions
```
EventDimensions dimensions
```
  The dimension settings of the event filter for the campaign.
- filterType
```
String filterType
```
  The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Events resource) occurs.

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

Serialized Fields
- lambdaFunctionName
```
String lambdaFunctionName
```
  The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to send messages for a campaign.
- mode
```
String mode
```
  Specifies which Lambda mode to use when invoking the AWS Lambda function.
- webUrl
```
String webUrl
```
  The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.

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

Serialized Fields
- daily
```
Integer daily
```
  The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. The maximum value is 100.
- maximumDuration
```
Integer maximumDuration
```
  The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.
- messagesPerSecond
```
Integer messagesPerSecond
```
  The maximum number of messages that a campaign can send each second. The minimum value is 50. The maximum value is 20,000.
- total
```
Integer total
```
  The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. The maximum value is 100.

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

Serialized Fields
- additionalTreatments
```
List<E> additionalTreatments
```
  An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.
- applicationId
```
String applicationId
```
  The unique identifier for the application that the campaign applies to.
- arn
```
String arn
```
  The Amazon Resource Name (ARN) of the campaign.
- creationDate
```
String creationDate
```
  The date, ISO 8601 format, when the campaign was created.
- defaultState
```
CampaignState defaultState
```
  The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment, to support A/B testing.
- description
```
String description
```
  The custom description of the campaign.
- holdoutPercent
```
Integer holdoutPercent
```
  The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
- hook
```
CampaignHook hook
```
  The settings for the AWS Lambda function to use as a code hook for the campaign.
- id
```
String id
```
  The unique identifier for the campaign.
- isPaused
```
Boolean isPaused
```
  Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.
- lastModifiedDate
```
String lastModifiedDate
```
  The date, in ISO 8601 format, when the campaign was last modified.
- limits
```
CampaignLimits limits
```
  The messaging limits for the campaign.
- messageConfiguration
```
MessageConfiguration messageConfiguration
```
  The message configuration settings for the campaign.
- name
```
String name
```
  The name of the campaign.
- schedule
```
Schedule schedule
```
  The schedule settings for the campaign.
- segmentId
```
String segmentId
```
  The unique identifier for the segment that's associated with the campaign.
- segmentVersion
```
Integer segmentVersion
```
  The version number of the segment that's associated with the campaign.
- state
```
CampaignState state
```
  The current status of the campaign.
- tags
```
Map<K,V> tags
```
  A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.
- treatmentDescription
```
String treatmentDescription
```
  The custom description of a variation of the campaign that's used for A/B testing.
- treatmentName
```
String treatmentName
```
  The custom name of a variation of the campaign that's used for A/B testing.
- version
```
Integer version
```
  The version number of the campaign.

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

Serialized Fields
- body
```
String body
```
  The body of the SMS message.
- messageType
```
String messageType
```
  The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.
- senderId
```
String senderId
```
  The sender ID to display on recipients' devices when they receive the SMS message.

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

Serialized Fields
- item
```
List<E> item
```
  An array of responses, one for each campaign that's associated with the application.
- nextToken
```
String nextToken
```
  The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

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. If a campaign uses A/B testing, the campaign has a status of COMPLETED only when all campaign treatments have a status of COMPLETED.

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

Serialized Fields
- applicationId
```
String applicationId
```
  The unique identifier for the application.
- creationDate
```
String creationDate
```
  The date and time, in ISO 8601 format, when the channel was enabled.
- enabled
```
Boolean enabled
```
  Specifies whether the channel is enabled for the application.
- hasCredential
```
Boolean hasCredential
```
  (Not used) This property is retained only for backward compatibility.
- id
```
String id
```
  (Deprecated) An identifier for the channel. This property is retained only for backward compatibility.
- isArchived
```
Boolean isArchived
```
  Specifies whether the channel is archived.
- lastModifiedBy
```
String lastModifiedBy
```
  The user who last modified the channel.
- lastModifiedDate
```
String lastModifiedDate
```
  The date and time, in ISO 8601 format, when the channel was last modified.
- version
```
Integer version
```
  The current version of the channel.

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

Serialized Fields
- channels
```
Map<K,V> channels
```
  A map that contains a multipart response for each channel. For each item in this object, the ChannelType is the key and the Channel is the value.

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

Serialized Fields
- name
```
String name
```
  The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console.
- tags
```
Map<K,V> tags
```
  A string-to-string map of key-value pairs that defines the tags to associate with the application. Each tag consists of a required tag key and an associated tag value.

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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
- 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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
- 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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
- 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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
- 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 default message body of the push notification, email, or SMS message.
- substitutions
```
Map<K,V> substitutions
```
  The default message variables to use in the push notification, email, or SMS message. You can override these default variables with individual address variables.

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

Serialized Fields
- action
```
String action
```
  The default action to occur if a recipient taps the push notification. Valid values are:
  - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
  - DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.
  - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
- body
```
String body
```
  The default body of the notification message.
- data
```
Map<K,V> data
```
  The JSON data payload to use for the default push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
- silentPush
```
Boolean silentPush
```
  Specifies whether the default notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or delivering messages to an in-app notification center.
- substitutions
```
Map<K,V> substitutions
```
  The default message variables to use in the notification message. You can override the default variables with individual address variables.
- title
```
String title
```
  The default title to display above the notification message on a recipient's device.
- url
```
String url
```
  The default URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

Class com.amazonaws.services.pinpoint.model.DeleteAdmChannelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields
- applicationId
```
String applicationId
```
  The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
- campaignId
```
String campaignId
```
  The unique identifier for 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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
- endpointId
```
String endpointId
```
  The unique identifier for 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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
- segmentId
```
String segmentId
```
  The unique identifier for 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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
- userId
```
String userId
```
  The unique identifier for 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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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 default push notification message for the ADM (Amazon Device Messaging) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).
- aPNSMessage
```
APNSMessage aPNSMessage
```
  The default push notification message for the APNs (Apple Push Notification service) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).
- baiduMessage
```
BaiduMessage baiduMessage
```
  The default push notification message for the Baidu (Baidu Cloud Push) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).
- defaultMessage
```
DefaultMessage defaultMessage
```
  The default message body for all channels.
- defaultPushNotificationMessage
```
DefaultPushNotificationMessage defaultPushNotificationMessage
```
  The default push notification message for all push channels.
- emailMessage
```
EmailMessage emailMessage
```
  The default message for the email channel. This message overrides the default message (DefaultMessage).
- gCMMessage
```
GCMMessage gCMMessage
```
  The default push notification message for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default push notification message (DefaultPushNotificationMessage).
- sMSMessage
```
SMSMessage sMSMessage
```
  The default message for the SMS channel. This message overrides the default message (DefaultMessage).
- voiceMessage
```
VoiceMessage voiceMessage
```
  The default message for the voice channel. This message overrides the default message (DefaultMessage).

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

Serialized Fields
- configurationSet
```
String configurationSet
```
  The configuration set that you want to apply to email that you send through the channel by using the Amazon Pinpoint Email API.
- enabled
```
Boolean enabled
```
  Specifies whether to enable the email channel for the application.
- fromAddress
```
String fromAddress
```
  The verified email address that you want to send email from when you send email through the channel.
- identity
```
String identity
```
  The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that you want to use when you send email through the channel.
- roleArn
```
String roleArn
```
  The ARN of the AWS Identity and Access Management (IAM) role that you want Amazon Pinpoint to use when it submits email-related event data for the channel.

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

Serialized Fields
- applicationId
```
String applicationId
```
  The unique identifier for the application that the email channel applies to.
- configurationSet
```
String configurationSet
```
  The configuration set that's applied to email that's sent through the channel by using the Amazon Pinpoint Email API.
- creationDate
```
String creationDate
```
  The date and time, in ISO 8601 format, when the email channel was enabled.
- enabled
```
Boolean enabled
```
  Specifies whether the email channel is enabled for the application.
- fromAddress
```
String fromAddress
```
  The verified email address that you send email from when you send email through the channel.
- hasCredential
```
Boolean hasCredential
```
  (Not used) This property is retained only for backward compatibility.
- id
```
String id
```
  (Deprecated) An identifier for the email channel. This property is retained only for backward compatibility.
- identity
```
String identity
```
  The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that you use when you send email through the channel.
- isArchived
```
Boolean isArchived
```
  Specifies whether the email channel is archived.
- lastModifiedBy
```
String lastModifiedBy
```
  The user who last modified the email channel.
- lastModifiedDate
```
String lastModifiedDate
```
  The date and time, in ISO 8601 format, when the email channel was last modified.
- messagesPerSecond
```
Integer messagesPerSecond
```
  The maximum number of emails that you can send through the channel each second.
- platform
```
String platform
```
  The type of messaging or notification platform for the channel. For the email channel, this value is EMAIL.
- roleArn
```
String roleArn
```
  The ARN of the AWS Identity and Access Management (IAM) role that Amazon Pinpoint uses to submit email-related event data for the channel.
- version
```
Integer version
```
  The current version of the email 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 to forward bounces and complaints to, if feedback forwarding is enabled.
- fromAddress
```
String fromAddress
```
  The verified email address to send the email message from. The default value is the FromAddress specified for the email channel.
- rawEmail
```
RawEmail rawEmail
```
  The email message, represented as a raw MIME message.
- replyToAddresses
```
List<E> replyToAddresses
```
  The reply-to email address(es) for the email message. If a recipient replies to the email, each reply-to address receives the reply.
- simpleEmail
```
SimpleEmail simpleEmail
```
  The email message, composed of a subject, a text part, and an HTML part.
- substitutions
```
Map<K,V> substitutions
```
  The default message variables to use in the email message. You can override the default variables with individual address variables.

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

Serialized Fields
- address
```
String address
```
  The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.
- attributes
```
Map<K,V> attributes
```
  One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["science", "music", "travel"]. You can use these attributes as filter criteria when you create segments.
  
  When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This limitation doesn't apply to attribute values.
- channelType
```
String channelType
```
  The channel to use when sending messages or push notifications to the endpoint.
- demographic
```
EndpointDemographic demographic
```
  The demographic information for the endpoint, such as the time zone and platform.
- effectiveDate
```
String effectiveDate
```
  The date and time, in ISO 8601 format, when the endpoint was created or updated.
- endpointStatus
```
String endpointStatus
```
  Not used.
- id
```
String id
```
  The unique identifier for the endpoint in the context of the batch.
- location
```
EndpointLocation location
```
  The geographic information for the endpoint.
- metrics
```
Map<K,V> metrics
```
  One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
- optOut
```
String optOut
```
  Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.
- requestId
```
String requestId
```
  The unique identifier for the request to create or update the endpoint.
- user
```
EndpointUser user
```
  One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.

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

Serialized Fields
- item
```
List<E> item
```
  An array that defines the endpoints to create or update and, for each endpoint, the property values to set or change. An array can contain a maximum of 100 items.

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

Serialized Fields
- appVersion
```
String appVersion
```
  The version of the app that's associated with the endpoint.
- locale
```
String locale
```
  The locale of the endpoint, in the following format: the ISO 639-1 alpha-2 code, followed by an underscore (_), followed by an ISO 3166-1 alpha-2 value.
- 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 time zone of the endpoint, specified as a tz database name value, such as America/Los_Angeles.

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

Serialized Fields
- message
```
String message
```
  The custom message that's returned in the response as a result of processing the endpoint data.
- statusCode
```
Integer statusCode
```
  The status code that's returned in the response as a result of processing the endpoint data.

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

Serialized Fields
- city
```
String city
```
  The name of the city where the endpoint is located.
- country
```
String country
```
  The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the endpoint is located. For example, US for the United States.
- latitude
```
Double latitude
```
  The latitude coordinate of the endpoint location, rounded to one decimal place.
- longitude
```
Double longitude
```
  The longitude coordinate of the endpoint location, rounded to one decimal place.
- postalCode
```
String postalCode
```
  The postal or ZIP code for the area where the endpoint is located.
- region
```
String region
```
  The name of the region where the endpoint is located. For locations in the United States, this value is the name of a state.

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

Serialized Fields
- address
```
String address
```
  The endpoint address that the message was delivered to.
- deliveryStatus
```
String deliveryStatus
```
  The delivery status of the message. Possible values are:
  - DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.
  - OPT_OUT - The user who's associated with the endpoint has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.
  - PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint. Amazon Pinpoint won't attempt to send the message again.
  - SUCCESSFUL - The message was successfully delivered to the endpoint.
  - TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint will attempt to deliver the message again later.
  - THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint.
  - TIMEOUT - The message couldn't be sent within the timeout period.
  - UNKNOWN_FAILURE - An unknown error occurred.
- messageId
```
String messageId
```
  The unique identifier for the message that was sent.
- statusCode
```
Integer statusCode
```
  The downstream service status code for delivering the message.
- statusMessage
```
String statusMessage
```
  The status message for delivering the message.
- updatedToken
```
String updatedToken
```
  For push notifications that are sent through the GCM channel, specifies whether the token was updated as part of delivering the message.

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

Serialized Fields
- address
```
String address
```
  The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.
- attributes
```
Map<K,V> attributes
```
  One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["science", "music", "travel"]. You can use these attributes as filter criteria when you create segments.
  
  When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This limitation doesn't apply to attribute values.
- channelType
```
String channelType
```
  The channel to use when sending messages or push notifications to the endpoint.
- demographic
```
EndpointDemographic demographic
```
  The demographic information for the endpoint, such as the time zone and platform.
- effectiveDate
```
String effectiveDate
```
  The date and time, in ISO 8601 format, when the endpoint is updated.
- endpointStatus
```
String endpointStatus
```
  Not used.
- location
```
EndpointLocation location
```
  The geographic information for the endpoint.
- metrics
```
Map<K,V> metrics
```
  One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
- optOut
```
String optOut
```
  Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.
- requestId
```
String requestId
```
  The unique identifier for the most recent request to update the endpoint.
- user
```
EndpointUser user
```
  One or more custom user attributes that describe the user who's associated with the endpoint.

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

Serialized Fields
- address
```
String address
```
  The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For example, the address for a push-notification channel is typically the token provided by a push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. The address for the SMS channel is a phone number in E.164 format, such as +12065550100. The address for the email channel is an email address.
- applicationId
```
String applicationId
```
  The unique identifier for the application that's associated with the endpoint.
- attributes
```
Map<K,V> attributes
```
  One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["science", "music", "travel"]. You can use these attributes as filter criteria when you create segments.
- channelType
```
String channelType
```
  The channel that's used when sending messages or push notifications to the endpoint.
- cohortId
```
String cohortId
```
  A number from 0-99 that represents the cohort that the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an application. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for campaigns.
- creationDate
```
String creationDate
```
  The date and time, in ISO 8601 format, when the endpoint was created.
- demographic
```
EndpointDemographic demographic
```
  The demographic information for the endpoint, such as the time zone and platform.
- effectiveDate
```
String effectiveDate
```
  The date and time, in ISO 8601 format, when the endpoint was last updated.
- endpointStatus
```
String endpointStatus
```
  Not used.
- id
```
String id
```
  The unique identifier that you assigned to the endpoint. The identifier should be a globally unique identifier (GUID) to ensure that it doesn't conflict with other endpoint identifiers that are associated with the application.
- location
```
EndpointLocation location
```
  The geographic information for the endpoint.
- metrics
```
Map<K,V> metrics
```
  One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
- optOut
```
String optOut
```
  Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.
- requestId
```
String requestId
```
  The unique identifier for the most recent request to update the endpoint.
- user
```
EndpointUser user
```
  One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.

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

Serialized Fields
- bodyOverride
```
String bodyOverride
```
  The body of the message. If specified, this value overrides the default message body.
- context
```
Map<K,V> context
```
  A map of custom attributes to attach to the message for the address. For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.
- rawContent
```
String rawContent
```
  The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides the message.
- substitutions
```
Map<K,V> substitutions
```
  A map of the message variables to merge with the variables specified for the default message (DefaultMessage.Substitutions). The variables specified in this map take precedence over all other variables.
- titleOverride
```
String titleOverride
```
  The title or subject line of the message. If specified, this value overrides the default message title or subject line.

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

Serialized Fields
- item
```
List<E> item
```
  An array of responses, one for each endpoint that's associated with the user ID.

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

Serialized Fields
- userAttributes
```
Map<K,V> userAttributes
```
  One or more custom attributes that describe the user by associating a name with an array of values. For example, the value of an attribute named Interests might be: ["science", "music", "travel"]. You can use these attributes as filter criteria when you create segments.
  
  When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This limitation doesn't apply to attribute values.
- userId
```
String userId
```
  The unique identifier for the user.

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

Serialized Fields
- appPackageName
```
String appPackageName
```
  The package name of 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
```
  One or more custom attributes that are associated with the event.
- clientSdkVersion
```
String clientSdkVersion
```
  The version of the SDK that's running on the client device.
- eventType
```
String eventType
```
  The name of the event.
- metrics
```
Map<K,V> metrics
```
  One or more custom metrics that are associated with 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, in ISO 8601 format, when the event occurred.

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

Serialized Fields
- attributes
```
Map<K,V> attributes
```
  One or more 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 type of event that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
- metrics
```
Map<K,V> metrics
```
  One or more custom metrics that your app reports to Amazon Pinpoint. You can use these metrics 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's returned in the response as a result of processing the event.
- statusCode
```
Integer statusCode
```
  The status code that's returned in the response as a result of processing the event. Possible values are: 202, for events that were accepted; and, 400, for events that weren't valid.

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

Serialized Fields
- endpoint
```
PublicEndpoint endpoint
```
  A set of properties and attributes that are associated with the endpoint.
- events
```
Map<K,V> events
```
  A set of properties that are associated with the event.

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

Serialized Fields
- batchItem
```
Map<K,V> batchItem
```
  The batch of events to process. For each item in a batch, the endpoint ID acts as a key that has an EventsBatch object as its value.

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. For each item in this object, the endpoint ID is the key and the item response is the value. If no item response exists, the value can also be one of the following: 202, the request was processed successfully; or 400, the payload wasn't valid or required fields were missing.

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

Serialized Fields
- applicationId
```
String applicationId
```
  The unique identifier for the application to publish event data for.
- destinationStreamArn
```
String destinationStreamArn
```
  The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream to publish event data to.
  
  For a Kinesis data stream, the ARN format is: arn:aws:kinesis:region:account -id:stream/stream_name
  
  For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region :account-id:deliverystream/stream_name
- externalId
```
String externalId
```
  (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when publishing event data, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
- lastModifiedDate
```
String lastModifiedDate
```
  The date, in ISO 8601 format, when the event stream was last modified.
- lastUpdatedBy
```
String lastUpdatedBy
```
  The IAM user who last modified the event stream.
- roleArn
```
String roleArn
```
  The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.

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

Serialized Fields
- roleArn
```
String roleArn
```
  The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location where you want to export endpoint definitions to.
- s3UrlPrefix
```
String s3UrlPrefix
```
  The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where you want to export endpoint definitions to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.
- segmentId
```
String segmentId
```
  The identifier for the segment to export endpoint definitions from. If you don't specify this value, Amazon Pinpoint exports definitions for all the endpoints that are associated with the application.
- segmentVersion
```
Integer segmentVersion
```
  The version of the segment to export endpoint definitions from, if specified.

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

Serialized Fields
- roleArn
```
String roleArn
```
  The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location where the endpoint definitions were exported to.
- s3UrlPrefix
```
String s3UrlPrefix
```
  The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where the endpoint definitions were exported to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.
- segmentId
```
String segmentId
```
  The identifier for the segment that the endpoint definitions were exported from. If this value isn't present, Amazon Pinpoint exported definitions for all the endpoints that are associated with the application.
- segmentVersion
```
Integer segmentVersion
```
  The version of the segment that the endpoint definitions were exported from.

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

Serialized Fields
- applicationId
```
String applicationId
```
  The unique identifier for the application that's associated with the export job.
- completedPieces
```
Integer completedPieces
```
  The number of pieces that were processed successfully (completed) by the export job, as of the time of the request.
- completionDate
```
String completionDate
```
  The date, in ISO 8601 format, when the export job was completed.
- creationDate
```
String creationDate
```
  The date, in ISO 8601 format, when the export job was created.
- definition
```
ExportJobResource definition
```
  The resource settings that apply to the export job.
- failedPieces
```
Integer failedPieces
```
  The number of pieces that weren't processed successfully (failed) by the export job, as of the time of the request.
- failures
```
List<E> failures
```
  An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the export job, if any.
- id
```
String id
```
  The unique identifier for the export job.
- jobStatus
```
String jobStatus
```
  The status of the export job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.
- totalFailures
```
Integer totalFailures
```
  The total number of endpoint definitions that weren't processed successfully (failed) by the export job, typically because an error, such as a syntax error, occurred.
- totalPieces
```
Integer totalPieces
```
  The total number of pieces that must be processed to complete the export job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the export job.
- totalProcessed
```
Integer totalProcessed
```
  The total number of endpoint definitions that were processed by the export job.
- type
```
String type
```
  The job type. This value is EXPORT for export jobs.

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

Serialized Fields
- item
```
List<E> item
```
  An array of responses, one for each export job that's associated with the application (Export Jobs resource) or segment (Segment Export Jobs resource).
- nextToken
```
String nextToken
```
  The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

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

serialVersionUID:: 1L

Serialized Fields
- requestID
```
String requestID
```
  The unique identifier for the request or response.

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

Serialized Fields
- apiKey
```
String apiKey
```
  The API key, also referred to as a server key, that you received from Google to communicate with Google services.
- enabled
```
Boolean enabled
```
  Specifies whether to enable the GCM channel for the application.

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

Serialized Fields
- applicationId
```
String applicationId
```
  The unique identifier for the application that the GCM channel applies to.
- creationDate
```
String creationDate
```
  The date and time when the GCM channel was enabled.
- credential
```
String credential
```
  The API key, also referred to as a server key, that you received from Google to communicate with Google services.
- enabled
```
Boolean enabled
```
  Specifies whether the GCM channel is enabled for the application.
- hasCredential
```
Boolean hasCredential
```
  (Not used) This property is retained only for backward compatibility.
- id
```
String id
```
  (Deprecated) An identifier for the GCM channel. This property is retained only for backward compatibility.
- isArchived
```
Boolean isArchived
```
  Specifies whether the GCM channel is archived.
- lastModifiedBy
```
String lastModifiedBy
```
  The user who last modified the GCM channel.
- lastModifiedDate
```
String lastModifiedDate
```
  The date and time when the GCM channel was last modified.
- platform
```
String platform
```
  The type of messaging or notification platform for the channel. For the GCM channel, this value is GCM.
- version
```
Integer version
```
  The current version of the GCM channel.

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

Serialized Fields
- action
```
String action
```
  The action to occur if the recipient taps the push notification. Valid values are:
  - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
  - DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
  - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
- body
```
String body
```
  The body of the notification message.
- collapseKey
```
String collapseKey
```
  An arbitrary string that identifies a group of messages that can be collapsed to ensure that only the last message is sent when delivery can resume. This helps avoid sending too many instances of the same messages when the recipient's device comes online again or becomes active.
  
  Amazon Pinpoint specifies this value in the Firebase Cloud Messaging (FCM) collapse_key parameter when it sends the notification message to FCM.
- data
```
Map<K,V> data
```
  The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
- iconReference
```
String iconReference
```
  The icon image name of the asset saved in your app.
- imageIconUrl
```
String imageIconUrl
```
  The URL of the large icon image to display in the content view of the push notification.
- imageUrl
```
String imageUrl
```
  The URL of an image to display in the push notification.
- priority
```
String priority
```
  para>normal - The notification might be delayed. Delivery is optimized for battery usage on the recipient's device. Use this value unless immediate delivery is required.
  /listitem>
- high - The notification is sent immediately and might wake a sleeping device.
- rawContent
```
String rawContent
```
  The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message.
- restrictedPackageName
```
String restrictedPackageName
```
  The package name of the application where registration tokens must match in order for the recipient to receive the message.
- silentPush
```
Boolean silentPush
```
  Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.
- smallImageIconUrl
```
String smallImageIconUrl
```
  The URL of the small icon image to display in the status bar and the content view of the push notification.
- sound
```
String sound
```
  The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
- substitutions
```
Map<K,V> substitutions
```
  The default message variables to use in the notification message. You can override the default variables with individual address variables.
- timeToLive
```
Integer timeToLive
```
  The amount of time, in seconds, that FCM should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If you don't specify this value, FCM defaults to the maximum value, which is 2,419,200 seconds (28 days).
  
  Amazon Pinpoint specifies this value in the FCM time_to_live parameter when it sends the notification message to FCM.
- title
```
String title
```
  The title to display above the notification message on the recipient's device.
- url
```
String url
```
  The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

Class com.amazonaws.services.pinpoint.model.GetAdmChannelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields
- applicationId
```
String applicationId
```
  The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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 maximum number of items to include on each page in a paginated response.
- token
```
String token
```
  The NextToken string that specifies which page of results to return 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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
- campaignId
```
String campaignId
```
  The unique identifier for the campaign.
- pageSize
```
String pageSize
```
  The maximum number of items to include on each page in a paginated response.
- token
```
String token
```
  The NextToken string that specifies which page of results to return 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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
- campaignId
```
String campaignId
```
  The unique identifier for 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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
- pageSize
```
String pageSize
```
  The maximum number of items to include on each page in a paginated response.
- token
```
String token
```
  The NextToken string that specifies which page of results to return 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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
- campaignId
```
String campaignId
```
  The unique identifier for the campaign.
- version
```
String version
```
  The unique version number (Version property) for the campaign version.

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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
- campaignId
```
String campaignId
```
  The unique identifier for the campaign.
- pageSize
```
String pageSize
```
  The maximum number of items to include on each page in a paginated response.
- token
```
String token
```
  The NextToken string that specifies which page of results to return 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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
- endpointId
```
String endpointId
```
  The unique identifier for 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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
- jobId
```
String jobId
```
  The unique identifier for 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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
- pageSize
```
String pageSize
```
  The maximum number of items to include on each page in a paginated response.
- token
```
String token
```
  The NextToken string that specifies which page of results to return 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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
- jobId
```
String jobId
```
  The unique identifier for 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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
- pageSize
```
String pageSize
```
  The maximum number of items to include on each page in a paginated response.
- token
```
String token
```
  The NextToken string that specifies which page of results to return 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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
- pageSize
```
String pageSize
```
  The maximum number of items to include on each page in a paginated response.
- segmentId
```
String segmentId
```
  The unique identifier for the segment.
- token
```
String token
```
  The NextToken string that specifies which page of results to return 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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
- pageSize
```
String pageSize
```
  The maximum number of items to include on each page in a paginated response.
- segmentId
```
String segmentId
```
  The unique identifier for the segment.
- token
```
String token
```
  The NextToken string that specifies which page of results to return 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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
- segmentId
```
String segmentId
```
  The unique identifier for 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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
- pageSize
```
String pageSize
```
  The maximum number of items to include on each page in a paginated response.
- token
```
String token
```
  The NextToken string that specifies which page of results to return 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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
- segmentId
```
String segmentId
```
  The unique identifier for the segment.
- version
```
String version
```
  The unique version number (Version property) for the campaign 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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
- pageSize
```
String pageSize
```
  The maximum number of items to include on each page in a paginated response.
- segmentId
```
String segmentId
```
  The unique identifier for the segment.
- token
```
String token
```
  The NextToken string that specifies which page of results to return 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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
- userId
```
String userId
```
  The unique identifier for 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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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
```
  The latitude coordinate of the location.
- longitude
```
Double longitude
```
  The longitude coordinate of the location.

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

Serialized Fields
- coordinates
```
GPSCoordinates coordinates
```
  The GPS coordinates to measure distance from.
- rangeInKilometers
```
Double rangeInKilometers
```
  The range, in kilometers, from the GPS coordinates.

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

Serialized Fields
- defineSegment
```
Boolean defineSegment
```
  Specifies whether to create a segment that contains the endpoints, when the endpoint definitions are imported.
- externalId
```
String externalId
```
  (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
- format
```
String format
```
  The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format. If the Amazon S3 location stores multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.
- registerEndpoints
```
Boolean registerEndpoints
```
  Specifies whether to register the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.
- roleArn
```
String roleArn
```
  The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.
- s3Url
```
String s3Url
```
  The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import. This location can be a folder or a single file. If the location is a folder, Amazon Pinpoint imports endpoint definitions from the files in this location, including any subfolders that the folder contains.
  
  The URL should be in the following format: s3://bucket-name/folder-name/file-name. The location can end with the key for an individual object or a prefix that qualifies multiple objects.
- segmentId
```
String segmentId
```
  The identifier for the segment to update or add the imported endpoint definitions to, if the import job is meant to update an existing segment.
- segmentName
```
String segmentName
```
  The custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.

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

Serialized Fields
- defineSegment
```
Boolean defineSegment
```
  Specifies whether the import job creates a segment that contains the endpoints, when the endpoint definitions are imported.
- externalId
```
String externalId
```
  (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
- format
```
String format
```
  The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.
  
  If the files are stored in an Amazon S3 location and that location contains multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.
- registerEndpoints
```
Boolean registerEndpoints
```
  Specifies whether the import job registers the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.
- roleArn
```
String roleArn
```
  The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.
- s3Url
```
String s3Url
```
  The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import. This location can be a folder or a single file. If the location is a folder, Amazon Pinpoint imports endpoint definitions from the files in this location, including any subfolders that the folder contains.
  
  The URL should be in the following format: s3://bucket-name/folder-name/file-name. The location can end with the key for an individual object or a prefix that qualifies multiple objects.
- segmentId
```
String segmentId
```
  The identifier for the segment that the import job updates or adds endpoint definitions to, if the import job updates an existing segment.
- segmentName
```
String segmentName
```
  The custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.

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

Serialized Fields
- applicationId
```
String applicationId
```
  The unique identifier for the application that's associated with the import job.
- completedPieces
```
Integer completedPieces
```
  The number of pieces that were processed successfully (completed) by the import job, as of the time of the request.
- completionDate
```
String completionDate
```
  The date, in ISO 8601 format, when the import job was completed.
- creationDate
```
String creationDate
```
  The date, in ISO 8601 format, when the import job was created.
- definition
```
ImportJobResource definition
```
  The resource settings that apply to the import job.
- failedPieces
```
Integer failedPieces
```
  The number of pieces that weren't processed successfully (failed) by the import job, as of the time of the request.
- failures
```
List<E> failures
```
  An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the import job, if any.
- id
```
String id
```
  The unique identifier for the import job.
- jobStatus
```
String jobStatus
```
  The status of the import job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.
- totalFailures
```
Integer totalFailures
```
  The total number of endpoint definitions that weren't processed successfully (failed) by the import job, typically because an error, such as a syntax error, occurred.
- totalPieces
```
Integer totalPieces
```
  The total number of pieces that must be processed to complete the import job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the import job.
- totalProcessed
```
Integer totalProcessed
```
  The total number of endpoint definitions that were processed by the import job.
- type
```
String type
```
  The job type. This value is IMPORT for import jobs.

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

Serialized Fields
- item
```
List<E> item
```
  An array of responses, one for each import job that's associated with the application (Import Jobs resource) or segment (Segment Import Jobs resource).
- nextToken
```
String nextToken
```
  The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

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

serialVersionUID:: 1L

Serialized Fields
- requestID
```
String requestID
```
  The unique identifier for the request or response.

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

Serialized Fields
- endpointItemResponse
```
EndpointItemResponse endpointItemResponse
```
  The response that was received after the endpoint data was accepted.
- eventsItemResponse
```
Map<K,V> eventsItemResponse
```
  A multipart response object that contains a key and a value for each event in the request. In each object, the event ID is the key and an EventItemResponse object is the value.

Class com.amazonaws.services.pinpoint.model.ListTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields
- resourceArn
```
String resourceArn
```
  The Amazon Resource Name (ARN) of the application, campaign, or segment.

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 to occur if a recipient taps the push notification. Valid values are:
  - OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
  - DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
  - URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
- body
```
String body
```
  The body of the notification message. The maximum number of characters is 200.
- imageIconUrl
```
String imageIconUrl
```
  The URL of the image to display as the push-notification icon, such as the icon for the app.
- imageSmallIconUrl
```
String imageSmallIconUrl
```
  The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
- imageUrl
```
String imageUrl
```
  The URL of an image to display in the push notification.
- jsonBody
```
String jsonBody
```
  The JSON payload to use for a silent push notification.
- mediaUrl
```
String mediaUrl
```
  The URL of the image or video to display in the push notification.
- rawContent
```
String rawContent
```
  The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.
- silentPush
```
Boolean silentPush
```
  Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
- timeToLive
```
Integer timeToLive
```
  The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
  
  This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
- title
```
String title
```
  The title to display above the notification message on a recipient's device.
- url
```
String url
```
  The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

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

Serialized Fields
- message
```
String message
```
  The message that's returned from the API.
- requestID
```
String requestID
```
  The unique identifier for the request or response.

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

Serialized Fields
- aDMMessage
```
Message aDMMessage
```
  The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.
- aPNSMessage
```
Message aPNSMessage
```
  The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.
- baiduMessage
```
Message baiduMessage
```
  The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.
- defaultMessage
```
Message defaultMessage
```
  The default message that the campaign sends through all the channels that are configured for the campaign.
- emailMessage
```
CampaignEmailMessage emailMessage
```
  The message that the campaign sends through the email channel.
- gCMMessage
```
Message gCMMessage
```
  The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default message.
- sMSMessage
```
CampaignSmsMessage sMSMessage
```
  The message that the campaign sends through the SMS channel.

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. You can use an AddressConfiguration object to tailor the message for an address by specifying settings such as content overrides and message variables.
- context
```
Map<K,V> context
```
  A map of custom attributes to attach to the message. For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.
- 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. You can use an EndpointSendConfiguration object to tailor the message for an endpoint by specifying settings such as content overrides and message variables.
- messageConfiguration
```
DirectMessageConfiguration messageConfiguration
```
  The set of properties that defines the configuration settings for the message.
- traceId
```
String traceId
```
  The unique identifier for tracing the message. This identifier is visible to message recipients.

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

Serialized Fields
- applicationId
```
String applicationId
```
  The unique identifier for the application that was used to send the message.
- endpointResult
```
Map<K,V> endpointResult
```
  A map that contains a multipart response for each address that the message was sent to. In the map, the endpoint ID is the key and the result is the value.
- requestId
```
String requestId
```
  The identifier for the original request that the message was delivered for.
- result
```
Map<K,V> result
```
  A map that contains a multipart response for each address (email address, phone number, or push notification token) that the message was sent to. In the map, the address is the key and the result is the value.

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

Serialized Fields
- deliveryStatus
```
String deliveryStatus
```
  The delivery status of the message. Possible values are:
  - DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.
  - OPT_OUT - The user who's associated with the endpoint address has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.
  - PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint address. Amazon Pinpoint won't attempt to send the message again.
  - SUCCESSFUL - The message was successfully delivered to the endpoint address.
  - TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint will attempt to deliver the message again later.
  - THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint address.
  - TIMEOUT - The message couldn't be sent within the timeout period.
  - UNKNOWN_FAILURE - An unknown error occurred.
- messageId
```
String messageId
```
  The unique identifier for the message that was sent.
- statusCode
```
Integer statusCode
```
  The downstream service status code for delivering the message.
- statusMessage
```
String statusMessage
```
  The status message for delivering the message.
- updatedToken
```
String updatedToken
```
  For push notifications that are sent through the GCM channel, specifies whether the token was updated as part of delivering the message.

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

serialVersionUID:: 1L

Serialized Fields
- requestID
```
String requestID
```
  The unique identifier for the request or response.

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

Serialized Fields
- comparisonOperator
```
String comparisonOperator
```
  The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
- value
```
Double value
```
  The value to compare.

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

serialVersionUID:: 1L

Serialized Fields
- requestID
```
String requestID
```
  The unique identifier for the request or response.

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

Serialized Fields
- isoCountryCode
```
String isoCountryCode
```
  The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the phone number was originally registered.
- phoneNumber
```
String phoneNumber
```
  The phone number to retrieve information about. The phone number that you provide should include a valid numeric country code. Otherwise, the operation might result in an error.

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

Serialized Fields
- carrier
```
String carrier
```
  The carrier or service provider that the phone number is currently registered with.
- city
```
String city
```
  The name of the city where the phone number was originally registered.
- cleansedPhoneNumberE164
```
String cleansedPhoneNumberE164
```
  The cleansed phone number, in E.164 format, for the location where the phone number was originally registered.
- cleansedPhoneNumberNational
```
String cleansedPhoneNumberNational
```
  The cleansed phone number, in the format for the location where the phone number was originally registered.
- country
```
String country
```
  The name of the country or region where the phone number was originally registered.
- countryCodeIso2
```
String countryCodeIso2
```
  The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the phone number was originally registered.
- countryCodeNumeric
```
String countryCodeNumeric
```
  The numeric code for the country or region where the phone number was originally registered.
- county
```
String county
```
  The name of the county where the phone number was originally registered.
- originalCountryCodeIso2
```
String originalCountryCodeIso2
```
  The two-character code, in ISO 3166-1 alpha-2 format, that was sent in the request body.
- originalPhoneNumber
```
String originalPhoneNumber
```
  The phone number that was sent in the request body.
- phoneType
```
String phoneType
```
  The description of the phone type. Valid values are: MOBILE, LANDLINE, VOIP, INVALID, PREPAID, and OTHER.
- phoneTypeCode
```
Integer phoneTypeCode
```
  The phone type, represented by an integer. Valid values are: 0 (mobile), 1 (landline), 2 (VoIP), 3 (invalid), 4 (other), and 5 (prepaid).
- timezone
```
String timezone
```
  The time zone for the location where the phone number was originally registered.
- zipCode
```
String zipCode
```
  The postal or ZIP 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, such as a device token, email address, or mobile phone number.
- attributes
```
Map<K,V> attributes
```
  One or more custom attributes that describe the endpoint by associating a name with an array of values. You can use these attributes as filter criteria when you create segments.
- channelType
```
String channelType
```
  The channel that's used when sending messages or push notifications to the endpoint.
- demographic
```
EndpointDemographic demographic
```
  The demographic information for the endpoint, such as the time zone and platform.
- effectiveDate
```
String effectiveDate
```
  The date and time, in ISO 8601 format, when the endpoint was last updated.
- endpointStatus
```
String endpointStatus
```
  The status of the update request for the endpoint. Possible values are: INACTIVE, the update failed; and, ACTIVE, the endpoint was updated successfully.
- location
```
EndpointLocation location
```
  The geographic information for the endpoint.
- metrics
```
Map<K,V> metrics
```
  One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
- optOut
```
String optOut
```
  Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.
- requestId
```
String requestId
```
  A unique identifier that's generated each time the endpoint is updated.
- user
```
EndpointUser user
```
  One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.

Class com.amazonaws.services.pinpoint.model.PutEventsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields
- applicationId
```
String applicationId
```
  The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
- 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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
- 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 specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
- start
```
String start
```
  The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

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

Serialized Fields
- data
```
ByteBuffer data
```
  The email message, represented as a raw MIME message. The entire message must be base64 encoded.

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

Serialized Fields
- duration
```
String duration
```
  The duration to use when determining whether an endpoint is active or inactive.
- recencyType
```
String recencyType
```
  The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.

Class com.amazonaws.services.pinpoint.model.RemoveAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields
- applicationId
```
String applicationId
```
  The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
- attributeType
```
String attributeType
```
  The type of attribute or attributes to remove. Valid values are:
  - endpoint-custom-attributes - Custom attributes that describe endpoints, such as the date when an associated user opted in or out of receiving communications from you through a specific type of channel.
  - endpoint-custom-metrics - Custom metrics that your app reports to Amazon Pinpoint for endpoints, such as the number of app sessions or the number of items left in a cart.
  - endpoint-user-attributes - Custom attributes that describe users, such as first name, last name, and age.
- updateAttributesRequest
```
UpdateAttributesRequest 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, in ISO 8601 format, for the campaign to end.
- eventFilter
```
CampaignEventFilter eventFilter
```
  The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
- frequency
```
String frequency
```
  Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
- isLocalTime
```
Boolean isLocalTime
```
  Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
- quietTime
```
QuietTime quietTime
```
  The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
  - The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
  - The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.
  - The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.
  If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
- startTime
```
String startTime
```
  The scheduled time, in ISO 8601 format, for the campaign to begin.
- timezone
```
String timezone
```
  The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.

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

Serialized Fields
- recency
```
RecencyDimension recency
```
  The dimension settings that are based on how recently an endpoint was active.

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
```
  One or more custom attributes to use as criteria for the segment.
- behavior
```
SegmentBehaviors behavior
```
  The behavior-based criteria, such as how recently users have used your app, for the segment.
- demographic
```
SegmentDemographics demographic
```
  The demographic-based criteria, such as device platform, for the segment.
- location
```
SegmentLocation location
```
  The location-based criteria, such as region or GPS coordinates, for the segment.
- metrics
```
Map<K,V> metrics
```
  One or more custom metrics to use as criteria for the segment.
- userAttributes
```
Map<K,V> userAttributes
```
  One or more custom user attributes to use as criteria for the segment.

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

Serialized Fields
- dimensions
```
List<E> dimensions
```
  An array that defines the dimensions for the segment.
- sourceSegments
```
List<E> sourceSegments
```
  The base segment to build the segment on. A base segment, also referred to as a source segment, defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify.
  
  You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size of the imported segment without any filters applied to it.
- sourceType
```
String sourceType
```
  Specifies how to handle multiple base segments for the segment. For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.
- type
```
String type
```
  Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.

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

Serialized Fields
- groups
```
List<E> groups
```
  An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.
- include
```
String include
```
  Specifies how to handle multiple segment groups for the segment. For example, if the segment includes three segment groups, whether the resulting segment includes endpoints that match all, any, or none of the segment groups.

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 endpoint definitions that were imported to create the segment.
- externalId
```
String externalId
```
  (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
- format
```
String format
```
  The format of the files that were imported to create the segment. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.
- roleArn
```
String roleArn
```
  The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.
- s3Url
```
String s3Url
```
  The URL of the Amazon Simple Storage Service (Amazon S3) bucket that the endpoint definitions were imported from to create the segment.
- size
```
Integer size
```
  The number of endpoint definitions that were imported successfully to create the segment.

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

Serialized Fields
- country
```
SetDimension country
```
  The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
- gPSPoint
```
GPSPointDimension gPSPoint
```
  The GPS location and range for the segment.

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

Serialized Fields
- id
```
String id
```
  The unique identifier for the segment.
- version
```
Integer version
```
  The version number of the segment.

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

Serialized Fields
- applicationId
```
String applicationId
```
  The unique identifier for the application that the segment is associated with.
- arn
```
String arn
```
  The Amazon Resource Name (ARN) of the segment.
- creationDate
```
String creationDate
```
  The date and time when the segment was created.
- dimensions
```
SegmentDimensions dimensions
```
  The dimension settings for the segment.
- id
```
String id
```
  The unique identifier for the segment.
- importDefinition
```
SegmentImportResource importDefinition
```
  The settings for the import job that's associated with the segment.
- 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 list of one or more segment groups that apply to the segment. Each segment group consists of zero or more base segments and the dimensions that are applied to those base segments.
- segmentType
```
String segmentType
```
  The segment type. Valid values are:
  - DIMENSIONAL - A dynamic segment, which is a segment that uses selection criteria that you specify and is based on endpoint data that's reported by your app. Dynamic segments can change over time.
  - IMPORT - A static segment, which is a segment that uses selection criteria that you specify and is based on endpoint definitions that you they don't change over time.
- tags
```
Map<K,V> tags
```
  A string-to-string map of key-value pairs that identifies the tags that are associated with the segment. Each tag consists of a required tag key and an associated tag value.
- version
```
Integer version
```
  The version number of the segment.

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

Serialized Fields
- item
```
List<E> item
```
  An array of responses, one for each segment that's associated with the application (Segments resource) or each version of a segment that's associated with the application (Segment Versions resource).
- nextToken
```
String nextToken
```
  The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

Class com.amazonaws.services.pinpoint.model.SendMessagesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields
- applicationId
```
String applicationId
```
  The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
- 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. For a push notification, Amazon Pinpoint adds these attributes to the data.pinpoint object in the body of the notification payload. Amazon Pinpoint also provides these attributes in the events that it generates for users-messages deliveries.
- messageConfiguration
```
DirectMessageConfiguration messageConfiguration
```
  The message definitions for the default message and any default messages that you defined for specific channels.
- traceId
```
String traceId
```
  The unique identifier for tracing the message. This identifier is visible to message recipients.
- users
```
Map<K,V> users
```
  A map that associates user IDs with EndpointSendConfiguration objects. You can use an EndpointSendConfiguration object to tailor the message for a user by specifying settings such as content overrides and message variables.

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

Serialized Fields
- applicationId
```
String applicationId
```
  The unique identifier for the application that was used to send the message.
- requestId
```
String requestId
```
  The unique identifier that was assigned to the message request.
- result
```
Map<K,V> result
```
  An object that indicates which endpoints the message was sent to, for each user. The object lists user IDs and, for each user ID, provides the endpoint IDs that the message was sent to. For each endpoint ID, it provides an EndpointMessageResult object.

Class com.amazonaws.services.pinpoint.model.SendUsersMessagesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields
- applicationId
```
String applicationId
```
  The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
- 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
```
  The 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 segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
- values
```
List<E> values
```
  The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

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

Serialized Fields
- htmlPart
```
SimpleEmailPart htmlPart
```
  The body of the email message, in HTML format. We recommend using an HTML part for email clients that support HTML. You can include links, formatted text, and more in an HTML message.
- subject
```
SimpleEmailPart subject
```
  The subject line, or title, of the email.
- textPart
```
SimpleEmailPart textPart
```
  The body of the email message, in text format. We recommend using a text part for email clients that don't support HTML and clients that are connected to high-latency networks, such as mobile devices.

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

Serialized Fields
- charset
```
String charset
```
  The applicable character set for the message content.
- data
```
String data
```
  The textual data of the message content.

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

Serialized Fields
- enabled
```
Boolean enabled
```
  Specifies whether to enable the SMS channel for the application.
- senderId
```
String senderId
```
  The identity that you want to display on recipients' devices when they receive messages from the SMS channel.
- shortCode
```
String shortCode
```
  The registered short code that you want to use when you send messages through the SMS channel.

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

Serialized Fields
- applicationId
```
String applicationId
```
  The unique identifier for the application that the SMS channel applies to.
- creationDate
```
String creationDate
```
  The date and time, in ISO 8601 format, when the SMS channel was enabled.
- enabled
```
Boolean enabled
```
  Specifies whether the SMS channel is enabled for the application.
- hasCredential
```
Boolean hasCredential
```
  (Not used) This property is retained only for backward compatibility.
- id
```
String id
```
  (Deprecated) An identifier for the SMS channel. This property is retained only for backward compatibility.
- isArchived
```
Boolean isArchived
```
  Specifies whether the SMS channel is archived.
- lastModifiedBy
```
String lastModifiedBy
```
  The user who last modified the SMS channel.
- lastModifiedDate
```
String lastModifiedDate
```
  The date and time, in ISO 8601 format, when the SMS channel was last modified.
- platform
```
String platform
```
  The type of messaging or notification platform for the channel. For the SMS channel, this value is SMS.
- promotionalMessagesPerSecond
```
Integer promotionalMessagesPerSecond
```
  The maximum number of promotional messages that you can send through the SMS channel each second.
- senderId
```
String senderId
```
  The identity that displays on recipients' devices when they receive messages from the SMS channel.
- shortCode
```
String shortCode
```
  The registered short code to use when you send messages through the SMS channel.
- transactionalMessagesPerSecond
```
Integer transactionalMessagesPerSecond
```
  The maximum number of transactional messages that you can send through the SMS channel each second.
- version
```
Integer version
```
  The current version of the SMS 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
```
  The SMS message type. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message is not critical or time-sensitive, such as a marketing message.
- originationNumber
```
String originationNumber
```
  The number that the SMS message originates from. This should be one of the dedicated long codes or short codes that you requested from AWS Support and is assigned to your AWS account. If you don't specify a long or short code, Amazon Pinpoint assigns a random long code to the SMS message.
- senderId
```
String senderId
```
  The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region.
- substitutions
```
Map<K,V> substitutions
```
  The message variables to use in the SMS message. You can override the default variables with individual address variables.

Class com.amazonaws.services.pinpoint.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields
- resourceArn
```
String resourceArn
```
  The Amazon Resource Name (ARN) of the application, campaign, or segment.
- 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
```
  A string-to-string map of key-value pairs that defines the tags for an application, campaign, or segment. A project, campaign, or segment can have a maximum of 50 tags.
  
  Each tag consists of a required tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

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

serialVersionUID:: 1L

Serialized Fields
- requestID
```
String requestID
```
  The unique identifier for the request or response.

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

Serialized Fields
- id
```
String id
```
  The unique identifier for the treatment.
- messageConfiguration
```
MessageConfiguration messageConfiguration
```
  The message configuration settings for the treatment.
- schedule
```
Schedule schedule
```
  The schedule settings for the treatment.
- sizePercent
```
Integer sizePercent
```
  The allocated percentage of users (segment members) that the treatment is sent to.
- state
```
CampaignState state
```
  The status of the treatment.
- treatmentDescription
```
String treatmentDescription
```
  The custom description of the treatment.
- treatmentName
```
String treatmentName
```
  The custom name of the treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.

Class com.amazonaws.services.pinpoint.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields
- resourceArn
```
String resourceArn
```
  The Amazon Resource Name (ARN) of the application, campaign, or segment.
- tagKeys
```
List<E> tagKeys
```
  The key of the tag to remove from the application, campaign, or segment. To remove multiple tags, append the tagKeys parameter and argument for each additional tag to remove, separated by an ampersand (&).

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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
- 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
```
  An array of the attributes to remove from all the endpoints that are associated with the application. The array can specify the complete, exact name of each attribute to remove or it can specify a glob pattern that an attribute name must match in order for the attribute to be removed.

Class com.amazonaws.services.pinpoint.model.UpdateBaiduChannelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields
- applicationId
```
String applicationId
```
  The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
- 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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
- campaignId
```
String campaignId
```
  The unique identifier for 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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
- 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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
- endpointId
```
String endpointId
```
  The unique identifier for 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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
- 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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
- 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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
- segmentId
```
String segmentId
```
  The unique identifier for 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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
- 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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
- 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
```
  Specifies whether to enable the voice channel for the application.

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

Serialized Fields
- applicationId
```
String applicationId
```
  The unique identifier for the application that the voice channel applies to.
- creationDate
```
String creationDate
```
  The date and time, in ISO 8601 format, when the voice channel was enabled.
- enabled
```
Boolean enabled
```
  Specifies whether the voice channel is enabled for the application.
- hasCredential
```
Boolean hasCredential
```
  (Not used) This property is retained only for backward compatibility.
- id
```
String id
```
  (Deprecated) An identifier for the voice channel. This property is retained only for backward compatibility.
- isArchived
```
Boolean isArchived
```
  Specifies whether the voice channel is archived.
- lastModifiedBy
```
String lastModifiedBy
```
  The user who last modified the voice channel.
- lastModifiedDate
```
String lastModifiedDate
```
  The date and time, in ISO 8601 format, when the voice channel was last modified.
- platform
```
String platform
```
  The type of messaging or notification platform for the channel. For the voice channel, this value is VOICE.
- version
```
Integer version
```
  The current version of the voice channel.

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

Serialized Fields
- body
```
String body
```
  The text script for the voice message.
- languageCode
```
String languageCode
```
  The language to use when delivering the message. For a list of supported languages, see the Amazon Polly Developer Guide.
- originationNumber
```
String originationNumber
```
  The phone number from the pool or messaging service to send the message from. Although it isn't required, we recommend that you specify the phone number in E.164 format to ensure prompt and accurate delivery.
- substitutions
```
Map<K,V> substitutions
```
  The default message variables to use in the voice message. You can override the default variables with individual address variables.
- voiceId
```
String voiceId
```
  The name of the voice to use when delivering the message. For a list of supported voices, see the Amazon Polly Developer Guide.

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

Serialized Fields
- campaignHook
```
CampaignHook campaignHook
```
  The settings for the AWS Lambda function to use by default as a code hook for campaigns in the application. To override these settings for a specific campaign, use the Campaign resource to define custom Lambda function settings for the campaign.
- cloudWatchMetricsEnabled
```
Boolean cloudWatchMetricsEnabled
```
  Specifies whether to enable application-related alarms in Amazon CloudWatch.
- limits
```
CampaignLimits limits
```
  The default sending limits for campaigns in the application. To override these limits for a specific campaign, use the Campaign resource to define custom limits for the campaign.
- quietTime
```
QuietTime quietTime
```
  The default quiet time for campaigns in the application. Quiet time is a specific time range when campaigns don't send messages to endpoints, if all the following conditions are met:
  - The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
  - The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application (or a campaign that has custom quiet time settings).
  - The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application (or a campaign that has custom quiet time settings).
  If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign, even if quiet time is enabled.
  
  To override the default quiet time settings for a specific campaign, use the Campaign resource to define a custom quiet time for the campaign.

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

Serialized Fields
- additionalTreatments
```
List<E> additionalTreatments
```
  An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
- description
```
String description
```
  The custom description of the campaign.
- holdoutPercent
```
Integer holdoutPercent
```
  The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
- hook
```
CampaignHook hook
```
  The settings for the AWS Lambda function to use as a code hook for the campaign.
- isPaused
```
Boolean isPaused
```
  Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by setting this value to false.
- limits
```
CampaignLimits limits
```
  The messaging limits for the campaign.
- messageConfiguration
```
MessageConfiguration messageConfiguration
```
  The message configuration settings for the campaign.
- name
```
String name
```
  The custom name of the campaign.
- schedule
```
Schedule schedule
```
  The schedule settings for the campaign.
- segmentId
```
String segmentId
```
  The unique identifier for the segment to associate with the campaign.
- segmentVersion
```
Integer segmentVersion
```
  The version of the segment to associate with the campaign.
- tags
```
Map<K,V> tags
```
  A string-to-string map of key-value pairs that defines the tags to associate with the campaign. Each tag consists of a required tag key and an associated tag value.
- treatmentDescription
```
String treatmentDescription
```
  The custom description of a variation of the campaign to use for A/B testing.
- treatmentName
```
String treatmentName
```
  The custom name of a variation of the campaign to use 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 data stream or Amazon Kinesis Data Firehose delivery stream that you want to publish event data to.
  
  For a Kinesis data stream, the ARN format is: arn:aws:kinesis:region:account -id:stream/stream_name
  
  For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region :account-id:deliverystream/stream_name
- roleArn
```
String roleArn
```
  The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.

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

Serialized Fields
- dimensions
```
SegmentDimensions dimensions
```
  The criteria that define the dimensions for the segment.
- name
```
String name
```
  The name of the segment.
- segmentGroups
```
SegmentGroupList segmentGroups
```
  The segment group to use and the dimensions to apply to the group's base segments in order to build the segment. A segment group can consist of zero or more base segments. Your request can include only one segment group.
- tags
```
Map<K,V> tags
```
  A string-to-string map of key-value pairs that defines the tags to associate with the segment. Each tag consists of a required tag key and an associated tag value.

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

Serialized Fields
- messageConfiguration
```
MessageConfiguration messageConfiguration
```
  The message configuration settings for the treatment.
- schedule
```
Schedule schedule
```
  The schedule settings for the treatment.
- sizePercent
```
Integer sizePercent
```
  The allocated percentage of users (segment members) to send the treatment to.
- treatmentDescription
```
String treatmentDescription
```
  The custom description of the treatment.
- treatmentName
```
String treatmentName
```
  The custom name of the treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.

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