com.amazonaws.services.pinpoint

Interface AmazonPinpoint

All Known Implementing Classes:

AmazonPinpointClient

public interface AmazonPinpoint

Interface for accessing AmazonPinpoint

Method Summary

Modifier and Type	Method and Description
CreateAppResult	createApp(CreateAppRequest createAppRequest) Creates or updates an app.
CreateCampaignResult	createCampaign(CreateCampaignRequest createCampaignRequest) Creates or updates a campaign.
CreateExportJobResult	createExportJob(CreateExportJobRequest createExportJobRequest) Creates an export job.
CreateImportJobResult	createImportJob(CreateImportJobRequest createImportJobRequest) Creates or updates an import job.
CreateSegmentResult	createSegment(CreateSegmentRequest createSegmentRequest) Used to create or update a segment.
DeleteAdmChannelResult	deleteAdmChannel(DeleteAdmChannelRequest deleteAdmChannelRequest) Delete an ADM channel
DeleteApnsChannelResult	deleteApnsChannel(DeleteApnsChannelRequest deleteApnsChannelRequest) Deletes the APNs channel for an app.
DeleteApnsSandboxChannelResult	deleteApnsSandboxChannel(DeleteApnsSandboxChannelRequest deleteApnsSandboxChannelRequest) Delete an APNS sandbox channel
DeleteApnsVoipChannelResult	deleteApnsVoipChannel(DeleteApnsVoipChannelRequest deleteApnsVoipChannelRequest) Delete an APNS VoIP channel
DeleteApnsVoipSandboxChannelResult	deleteApnsVoipSandboxChannel(DeleteApnsVoipSandboxChannelRequest deleteApnsVoipSandboxChannelRequest) Delete an APNS VoIP sandbox channel
DeleteAppResult	deleteApp(DeleteAppRequest deleteAppRequest) Deletes an app.
DeleteBaiduChannelResult	deleteBaiduChannel(DeleteBaiduChannelRequest deleteBaiduChannelRequest) Delete a BAIDU GCM channel
DeleteCampaignResult	deleteCampaign(DeleteCampaignRequest deleteCampaignRequest) Deletes a campaign.
DeleteEmailChannelResult	deleteEmailChannel(DeleteEmailChannelRequest deleteEmailChannelRequest) Delete an email channel
DeleteEndpointResult	deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest) Deletes an endpoint.
DeleteEventStreamResult	deleteEventStream(DeleteEventStreamRequest deleteEventStreamRequest) Deletes the event stream for an app.
DeleteGcmChannelResult	deleteGcmChannel(DeleteGcmChannelRequest deleteGcmChannelRequest) Deletes the GCM channel for an app.
DeleteSegmentResult	deleteSegment(DeleteSegmentRequest deleteSegmentRequest) Deletes a segment.
DeleteSmsChannelResult	deleteSmsChannel(DeleteSmsChannelRequest deleteSmsChannelRequest) Delete an SMS channel
GetAdmChannelResult	getAdmChannel(GetAdmChannelRequest getAdmChannelRequest) Get an ADM channel
GetApnsChannelResult	getApnsChannel(GetApnsChannelRequest getApnsChannelRequest) Returns information about the APNs channel for an app.
GetApnsSandboxChannelResult	getApnsSandboxChannel(GetApnsSandboxChannelRequest getApnsSandboxChannelRequest) Get an APNS sandbox channel
GetApnsVoipChannelResult	getApnsVoipChannel(GetApnsVoipChannelRequest getApnsVoipChannelRequest) Get an APNS VoIP channel
GetApnsVoipSandboxChannelResult	getApnsVoipSandboxChannel(GetApnsVoipSandboxChannelRequest getApnsVoipSandboxChannelRequest) Get an APNS VoIPSandbox channel
GetAppResult	getApp(GetAppRequest getAppRequest) Returns information about an app.
GetApplicationSettingsResult	getApplicationSettings(GetApplicationSettingsRequest getApplicationSettingsRequest) Used to request the settings for an app.
GetAppsResult	getApps(GetAppsRequest getAppsRequest) Returns information about your apps.
GetBaiduChannelResult	getBaiduChannel(GetBaiduChannelRequest getBaiduChannelRequest) Get a BAIDU GCM channel
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetCampaignResult	getCampaign(GetCampaignRequest getCampaignRequest) Returns information about a campaign.
GetCampaignActivitiesResult	getCampaignActivities(GetCampaignActivitiesRequest getCampaignActivitiesRequest) Returns information about the activity performed by a campaign.
GetCampaignsResult	getCampaigns(GetCampaignsRequest getCampaignsRequest) Returns information about your campaigns.
GetCampaignVersionResult	getCampaignVersion(GetCampaignVersionRequest getCampaignVersionRequest) Returns information about a specific version of a campaign.
GetCampaignVersionsResult	getCampaignVersions(GetCampaignVersionsRequest getCampaignVersionsRequest) Returns information about your campaign versions.
GetEmailChannelResult	getEmailChannel(GetEmailChannelRequest getEmailChannelRequest) Get an email channel
GetEndpointResult	getEndpoint(GetEndpointRequest getEndpointRequest) Returns information about an endpoint.
GetEventStreamResult	getEventStream(GetEventStreamRequest getEventStreamRequest) Returns the event stream for an app.
GetExportJobResult	getExportJob(GetExportJobRequest getExportJobRequest) Returns information about an export job.
GetExportJobsResult	getExportJobs(GetExportJobsRequest getExportJobsRequest) Returns information about your export jobs.
GetGcmChannelResult	getGcmChannel(GetGcmChannelRequest getGcmChannelRequest) Returns information about the GCM channel for an app.
GetImportJobResult	getImportJob(GetImportJobRequest getImportJobRequest) Returns information about an import job.
GetImportJobsResult	getImportJobs(GetImportJobsRequest getImportJobsRequest) Returns information about your import jobs.
GetSegmentResult	getSegment(GetSegmentRequest getSegmentRequest) Returns information about a segment.
GetSegmentExportJobsResult	getSegmentExportJobs(GetSegmentExportJobsRequest getSegmentExportJobsRequest) Returns a list of export jobs for a specific segment.
GetSegmentImportJobsResult	getSegmentImportJobs(GetSegmentImportJobsRequest getSegmentImportJobsRequest) Returns a list of import jobs for a specific segment.
GetSegmentsResult	getSegments(GetSegmentsRequest getSegmentsRequest) Used to get information about your segments.
GetSegmentVersionResult	getSegmentVersion(GetSegmentVersionRequest getSegmentVersionRequest) Returns information about a segment version.
GetSegmentVersionsResult	getSegmentVersions(GetSegmentVersionsRequest getSegmentVersionsRequest) Returns information about your segment versions.
GetSmsChannelResult	getSmsChannel(GetSmsChannelRequest getSmsChannelRequest) Get an SMS channel
PutEventStreamResult	putEventStream(PutEventStreamRequest putEventStreamRequest) Use to create or update the event stream for an app.
SendMessagesResult	sendMessages(SendMessagesRequest sendMessagesRequest) Send a batch of messages
SendUsersMessagesResult	sendUsersMessages(SendUsersMessagesRequest sendUsersMessagesRequest) Send a batch of messages to users
void	setEndpoint(String endpoint) Overrides the default endpoint for this client ("https://pinpoint.us-east-1.amazonaws.com").
void	setRegion(Region region) An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
UpdateAdmChannelResult	updateAdmChannel(UpdateAdmChannelRequest updateAdmChannelRequest) Update an ADM channel
UpdateApnsChannelResult	updateApnsChannel(UpdateApnsChannelRequest updateApnsChannelRequest) Use to update the APNs channel for an app.
UpdateApnsSandboxChannelResult	updateApnsSandboxChannel(UpdateApnsSandboxChannelRequest updateApnsSandboxChannelRequest) Update an APNS sandbox channel
UpdateApnsVoipChannelResult	updateApnsVoipChannel(UpdateApnsVoipChannelRequest updateApnsVoipChannelRequest) Update an APNS VoIP channel
UpdateApnsVoipSandboxChannelResult	updateApnsVoipSandboxChannel(UpdateApnsVoipSandboxChannelRequest updateApnsVoipSandboxChannelRequest) Update an APNS VoIP sandbox channel
UpdateApplicationSettingsResult	updateApplicationSettings(UpdateApplicationSettingsRequest updateApplicationSettingsRequest) Used to update the settings for an app.
UpdateBaiduChannelResult	updateBaiduChannel(UpdateBaiduChannelRequest updateBaiduChannelRequest) Update a BAIDU GCM channel
UpdateCampaignResult	updateCampaign(UpdateCampaignRequest updateCampaignRequest) Use to update a campaign.
UpdateEmailChannelResult	updateEmailChannel(UpdateEmailChannelRequest updateEmailChannelRequest) Update an email channel
UpdateEndpointResult	updateEndpoint(UpdateEndpointRequest updateEndpointRequest) Use to update an endpoint.
UpdateEndpointsBatchResult	updateEndpointsBatch(UpdateEndpointsBatchRequest updateEndpointsBatchRequest) Use to update a batch of endpoints.
UpdateGcmChannelResult	updateGcmChannel(UpdateGcmChannelRequest updateGcmChannelRequest) Use to update the GCM channel for an app.
UpdateSegmentResult	updateSegment(UpdateSegmentRequest updateSegmentRequest) Use to update a segment.
UpdateSmsChannelResult	updateSmsChannel(UpdateSmsChannelRequest updateSmsChannelRequest) Update an SMS channel

Method Detail

setEndpoint

void setEndpoint(String endpoint)
          throws IllegalArgumentException

Overrides the default endpoint for this client ("https://pinpoint.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "pinpoint.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://pinpoint.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

endpoint - The endpoint (ex: "pinpoint.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://pinpoint.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

Throws:

IllegalArgumentException - If any problems are detected with the specified endpoint.

setRegion

void setRegion(Region region)
        throws IllegalArgumentException

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region.

Throws:

IllegalArgumentException - If the given region is null, or if this service isn't available in the given region. See Region.isServiceSupported(String)

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)

createApp

CreateAppResult createApp(CreateAppRequest createAppRequest)
                   throws AmazonClientException,
                          AmazonServiceException

Creates or updates an app.

Parameters:

createAppRequest -

Returns:

createAppResult The response from the CreateApp service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

createCampaign

CreateCampaignResult createCampaign(CreateCampaignRequest createCampaignRequest)
                             throws AmazonClientException,
                                    AmazonServiceException

Creates or updates a campaign.

Parameters:

createCampaignRequest -

Returns:

createCampaignResult The response from the CreateCampaign service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

createExportJob

CreateExportJobResult createExportJob(CreateExportJobRequest createExportJobRequest)
                               throws AmazonClientException,
                                      AmazonServiceException

Creates an export job.

Parameters:

createExportJobRequest -

Returns:

createExportJobResult The response from the CreateExportJob service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

createImportJob

CreateImportJobResult createImportJob(CreateImportJobRequest createImportJobRequest)
                               throws AmazonClientException,
                                      AmazonServiceException

Creates or updates an import job.

Parameters:

createImportJobRequest -

Returns:

createImportJobResult The response from the CreateImportJob service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

createSegment

CreateSegmentResult createSegment(CreateSegmentRequest createSegmentRequest)
                           throws AmazonClientException,
                                  AmazonServiceException

Used to create or update a segment.

Parameters:

createSegmentRequest -

Returns:

createSegmentResult The response from the CreateSegment service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

deleteAdmChannel

DeleteAdmChannelResult deleteAdmChannel(DeleteAdmChannelRequest deleteAdmChannelRequest)
                                 throws AmazonClientException,
                                        AmazonServiceException

Delete an ADM channel

Parameters:

deleteAdmChannelRequest -

Returns:

deleteAdmChannelResult The response from the DeleteAdmChannel service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

deleteApnsChannel

DeleteApnsChannelResult deleteApnsChannel(DeleteApnsChannelRequest deleteApnsChannelRequest)
                                   throws AmazonClientException,
                                          AmazonServiceException

Deletes the APNs channel for an app.

Parameters:

deleteApnsChannelRequest -

Returns:

deleteApnsChannelResult The response from the DeleteApnsChannel service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

deleteApnsSandboxChannel

DeleteApnsSandboxChannelResult deleteApnsSandboxChannel(DeleteApnsSandboxChannelRequest deleteApnsSandboxChannelRequest)
                                                 throws AmazonClientException,
                                                        AmazonServiceException

Delete an APNS sandbox channel

Parameters:

deleteApnsSandboxChannelRequest -

Returns:

deleteApnsSandboxChannelResult The response from the DeleteApnsSandboxChannel service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

deleteApnsVoipChannel

DeleteApnsVoipChannelResult deleteApnsVoipChannel(DeleteApnsVoipChannelRequest deleteApnsVoipChannelRequest)
                                           throws AmazonClientException,
                                                  AmazonServiceException

Delete an APNS VoIP channel

Parameters:

deleteApnsVoipChannelRequest -

Returns:

deleteApnsVoipChannelResult The response from the DeleteApnsVoipChannel service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

deleteApnsVoipSandboxChannel

DeleteApnsVoipSandboxChannelResult deleteApnsVoipSandboxChannel(DeleteApnsVoipSandboxChannelRequest deleteApnsVoipSandboxChannelRequest)
                                                         throws AmazonClientException,
                                                                AmazonServiceException

Delete an APNS VoIP sandbox channel

Parameters:

deleteApnsVoipSandboxChannelRequest -

Returns:

deleteApnsVoipSandboxChannelResult The response from the DeleteApnsVoipSandboxChannel service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

deleteApp

DeleteAppResult deleteApp(DeleteAppRequest deleteAppRequest)
                   throws AmazonClientException,
                          AmazonServiceException

Deletes an app.

Parameters:

deleteAppRequest -

Returns:

deleteAppResult The response from the DeleteApp service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

deleteBaiduChannel

DeleteBaiduChannelResult deleteBaiduChannel(DeleteBaiduChannelRequest deleteBaiduChannelRequest)
                                     throws AmazonClientException,
                                            AmazonServiceException

Delete a BAIDU GCM channel

Parameters:

deleteBaiduChannelRequest -

Returns:

deleteBaiduChannelResult The response from the DeleteBaiduChannel service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

deleteCampaign

DeleteCampaignResult deleteCampaign(DeleteCampaignRequest deleteCampaignRequest)
                             throws AmazonClientException,
                                    AmazonServiceException

Deletes a campaign.

Parameters:

deleteCampaignRequest -

Returns:

deleteCampaignResult The response from the DeleteCampaign service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

deleteEmailChannel

DeleteEmailChannelResult deleteEmailChannel(DeleteEmailChannelRequest deleteEmailChannelRequest)
                                     throws AmazonClientException,
                                            AmazonServiceException

Delete an email channel

Parameters:

deleteEmailChannelRequest -

Returns:

deleteEmailChannelResult The response from the DeleteEmailChannel service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

deleteEndpoint

DeleteEndpointResult deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest)
                             throws AmazonClientException,
                                    AmazonServiceException

Deletes an endpoint.

Parameters:

deleteEndpointRequest -

Returns:

deleteEndpointResult The response from the DeleteEndpoint service method, as returned by AmazonPinpoint.

Throws:

BadRequestException - 400 response

InternalServerErrorException - 500 response

ForbiddenException - 403 response

NotFoundException - 404 response

MethodNotAllowedException - 405 response

TooManyRequestsException - 429 response

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

deleteEventStream

DeleteEventStreamResult deleteEventStream(DeleteEventStreamRequest deleteEventStreamRequest)
                                   throws AmazonClientException,
                                          AmazonServiceException

Deletes the event stream for an app.

Parameters:

deleteEventStreamRequest - DeleteEventStream Request

Returns:

deleteEventStreamResult The response from the DeleteEventStream service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

deleteGcmChannel

DeleteGcmChannelResult deleteGcmChannel(DeleteGcmChannelRequest deleteGcmChannelRequest)
                                 throws AmazonClientException,
                                        AmazonServiceException

Deletes the GCM channel for an app.

Parameters:

deleteGcmChannelRequest -

Returns:

deleteGcmChannelResult The response from the DeleteGcmChannel service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

deleteSegment

DeleteSegmentResult deleteSegment(DeleteSegmentRequest deleteSegmentRequest)
                           throws AmazonClientException,
                                  AmazonServiceException

Deletes a segment.

Parameters:

deleteSegmentRequest -

Returns:

deleteSegmentResult The response from the DeleteSegment service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

deleteSmsChannel

DeleteSmsChannelResult deleteSmsChannel(DeleteSmsChannelRequest deleteSmsChannelRequest)
                                 throws AmazonClientException,
                                        AmazonServiceException

Delete an SMS channel

Parameters:

deleteSmsChannelRequest -

Returns:

deleteSmsChannelResult The response from the DeleteSmsChannel service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

getAdmChannel

GetAdmChannelResult getAdmChannel(GetAdmChannelRequest getAdmChannelRequest)
                           throws AmazonClientException,
                                  AmazonServiceException

Get an ADM channel

Parameters:

getAdmChannelRequest -

Returns:

getAdmChannelResult The response from the GetAdmChannel service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

getApnsChannel

GetApnsChannelResult getApnsChannel(GetApnsChannelRequest getApnsChannelRequest)
                             throws AmazonClientException,
                                    AmazonServiceException

Returns information about the APNs channel for an app.

Parameters:

getApnsChannelRequest -

Returns:

getApnsChannelResult The response from the GetApnsChannel service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

getApnsSandboxChannel

GetApnsSandboxChannelResult getApnsSandboxChannel(GetApnsSandboxChannelRequest getApnsSandboxChannelRequest)
                                           throws AmazonClientException,
                                                  AmazonServiceException

Get an APNS sandbox channel

Parameters:

getApnsSandboxChannelRequest -

Returns:

getApnsSandboxChannelResult The response from the GetApnsSandboxChannel service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

getApnsVoipChannel

GetApnsVoipChannelResult getApnsVoipChannel(GetApnsVoipChannelRequest getApnsVoipChannelRequest)
                                     throws AmazonClientException,
                                            AmazonServiceException

Get an APNS VoIP channel

Parameters:

getApnsVoipChannelRequest -

Returns:

getApnsVoipChannelResult The response from the GetApnsVoipChannel service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

getApnsVoipSandboxChannel

GetApnsVoipSandboxChannelResult getApnsVoipSandboxChannel(GetApnsVoipSandboxChannelRequest getApnsVoipSandboxChannelRequest)
                                                   throws AmazonClientException,
                                                          AmazonServiceException

Get an APNS VoIPSandbox channel

Parameters:

getApnsVoipSandboxChannelRequest -

Returns:

getApnsVoipSandboxChannelResult The response from the GetApnsVoipSandboxChannel service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

getApp

GetAppResult getApp(GetAppRequest getAppRequest)
             throws AmazonClientException,
                    AmazonServiceException

Returns information about an app.

Parameters:

getAppRequest -

Returns:

getAppResult The response from the GetApp service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

getApplicationSettings

GetApplicationSettingsResult getApplicationSettings(GetApplicationSettingsRequest getApplicationSettingsRequest)
                                             throws AmazonClientException,
                                                    AmazonServiceException

Used to request the settings for an app.

Parameters:

getApplicationSettingsRequest -

Returns:

getApplicationSettingsResult The response from the GetApplicationSettings service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

getApps

GetAppsResult getApps(GetAppsRequest getAppsRequest)
               throws AmazonClientException,
                      AmazonServiceException

Returns information about your apps.

Parameters:

getAppsRequest -

Returns:

getAppsResult The response from the GetApps service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

getBaiduChannel

GetBaiduChannelResult getBaiduChannel(GetBaiduChannelRequest getBaiduChannelRequest)
                               throws AmazonClientException,
                                      AmazonServiceException

Get a BAIDU GCM channel

Parameters:

getBaiduChannelRequest -

Returns:

getBaiduChannelResult The response from the GetBaiduChannel service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

getCampaign

GetCampaignResult getCampaign(GetCampaignRequest getCampaignRequest)
                       throws AmazonClientException,
                              AmazonServiceException

Returns information about a campaign.

Parameters:

getCampaignRequest -

Returns:

getCampaignResult The response from the GetCampaign service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

getCampaignActivities

GetCampaignActivitiesResult getCampaignActivities(GetCampaignActivitiesRequest getCampaignActivitiesRequest)
                                           throws AmazonClientException,
                                                  AmazonServiceException

Returns information about the activity performed by a campaign.

Parameters:

getCampaignActivitiesRequest -

Returns:

getCampaignActivitiesResult The response from the GetCampaignActivities service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

getCampaignVersion

GetCampaignVersionResult getCampaignVersion(GetCampaignVersionRequest getCampaignVersionRequest)
                                     throws AmazonClientException,
                                            AmazonServiceException

Returns information about a specific version of a campaign.

Parameters:

getCampaignVersionRequest -

Returns:

getCampaignVersionResult The response from the GetCampaignVersion service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

getCampaignVersions

GetCampaignVersionsResult getCampaignVersions(GetCampaignVersionsRequest getCampaignVersionsRequest)
                                       throws AmazonClientException,
                                              AmazonServiceException

Returns information about your campaign versions.

Parameters:

getCampaignVersionsRequest -

Returns:

getCampaignVersionsResult The response from the GetCampaignVersions service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

getCampaigns

GetCampaignsResult getCampaigns(GetCampaignsRequest getCampaignsRequest)
                         throws AmazonClientException,
                                AmazonServiceException

Returns information about your campaigns.

Parameters:

getCampaignsRequest -

Returns:

getCampaignsResult The response from the GetCampaigns service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

getEmailChannel

GetEmailChannelResult getEmailChannel(GetEmailChannelRequest getEmailChannelRequest)
                               throws AmazonClientException,
                                      AmazonServiceException

Get an email channel

Parameters:

getEmailChannelRequest -

Returns:

getEmailChannelResult The response from the GetEmailChannel service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

getEndpoint

GetEndpointResult getEndpoint(GetEndpointRequest getEndpointRequest)
                       throws AmazonClientException,
                              AmazonServiceException

Returns information about an endpoint.

Parameters:

getEndpointRequest -

Returns:

getEndpointResult The response from the GetEndpoint service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

getEventStream

GetEventStreamResult getEventStream(GetEventStreamRequest getEventStreamRequest)
                             throws AmazonClientException,
                                    AmazonServiceException

Returns the event stream for an app.

Parameters:

getEventStreamRequest - GetEventStreamRequest

Returns:

getEventStreamResult The response from the GetEventStream service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

getExportJob

GetExportJobResult getExportJob(GetExportJobRequest getExportJobRequest)
                         throws AmazonClientException,
                                AmazonServiceException

Returns information about an export job.

Parameters:

getExportJobRequest -

Returns:

getExportJobResult The response from the GetExportJob service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

getExportJobs

GetExportJobsResult getExportJobs(GetExportJobsRequest getExportJobsRequest)
                           throws AmazonClientException,
                                  AmazonServiceException

Returns information about your export jobs.

Parameters:

getExportJobsRequest -

Returns:

getExportJobsResult The response from the GetExportJobs service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

getGcmChannel

GetGcmChannelResult getGcmChannel(GetGcmChannelRequest getGcmChannelRequest)
                           throws AmazonClientException,
                                  AmazonServiceException

Returns information about the GCM channel for an app.

Parameters:

getGcmChannelRequest -

Returns:

getGcmChannelResult The response from the GetGcmChannel service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

getImportJob

GetImportJobResult getImportJob(GetImportJobRequest getImportJobRequest)
                         throws AmazonClientException,
                                AmazonServiceException

Returns information about an import job.

Parameters:

getImportJobRequest -

Returns:

getImportJobResult The response from the GetImportJob service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

getImportJobs

GetImportJobsResult getImportJobs(GetImportJobsRequest getImportJobsRequest)
                           throws AmazonClientException,
                                  AmazonServiceException

Returns information about your import jobs.

Parameters:

getImportJobsRequest -

Returns:

getImportJobsResult The response from the GetImportJobs service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

getSegment

GetSegmentResult getSegment(GetSegmentRequest getSegmentRequest)
                     throws AmazonClientException,
                            AmazonServiceException

Returns information about a segment.

Parameters:

getSegmentRequest -

Returns:

getSegmentResult The response from the GetSegment service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

getSegmentExportJobs

GetSegmentExportJobsResult getSegmentExportJobs(GetSegmentExportJobsRequest getSegmentExportJobsRequest)
                                         throws AmazonClientException,
                                                AmazonServiceException

Returns a list of export jobs for a specific segment.

Parameters:

getSegmentExportJobsRequest -

Returns:

getSegmentExportJobsResult The response from the GetSegmentExportJobs service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

getSegmentImportJobs

GetSegmentImportJobsResult getSegmentImportJobs(GetSegmentImportJobsRequest getSegmentImportJobsRequest)
                                         throws AmazonClientException,
                                                AmazonServiceException

Returns a list of import jobs for a specific segment.

Parameters:

getSegmentImportJobsRequest -

Returns:

getSegmentImportJobsResult The response from the GetSegmentImportJobs service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

getSegmentVersion

GetSegmentVersionResult getSegmentVersion(GetSegmentVersionRequest getSegmentVersionRequest)
                                   throws AmazonClientException,
                                          AmazonServiceException

Returns information about a segment version.

Parameters:

getSegmentVersionRequest -

Returns:

getSegmentVersionResult The response from the GetSegmentVersion service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

getSegmentVersions

GetSegmentVersionsResult getSegmentVersions(GetSegmentVersionsRequest getSegmentVersionsRequest)
                                     throws AmazonClientException,
                                            AmazonServiceException

Returns information about your segment versions.

Parameters:

getSegmentVersionsRequest -

Returns:

getSegmentVersionsResult The response from the GetSegmentVersions service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

getSegments

GetSegmentsResult getSegments(GetSegmentsRequest getSegmentsRequest)
                       throws AmazonClientException,
                              AmazonServiceException

Used to get information about your segments.

Parameters:

getSegmentsRequest -

Returns:

getSegmentsResult The response from the GetSegments service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

getSmsChannel

GetSmsChannelResult getSmsChannel(GetSmsChannelRequest getSmsChannelRequest)
                           throws AmazonClientException,
                                  AmazonServiceException

Get an SMS channel

Parameters:

getSmsChannelRequest -

Returns:

getSmsChannelResult The response from the GetSmsChannel service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

putEventStream

PutEventStreamResult putEventStream(PutEventStreamRequest putEventStreamRequest)
                             throws AmazonClientException,
                                    AmazonServiceException

Use to create or update the event stream for an app.

Parameters:

putEventStreamRequest -

Returns:

putEventStreamResult The response from the PutEventStream service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

sendMessages

SendMessagesResult sendMessages(SendMessagesRequest sendMessagesRequest)
                         throws AmazonClientException,
                                AmazonServiceException

Send a batch of messages

Parameters:

sendMessagesRequest -

Returns:

sendMessagesResult The response from the SendMessages service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

sendUsersMessages

SendUsersMessagesResult sendUsersMessages(SendUsersMessagesRequest sendUsersMessagesRequest)
                                   throws AmazonClientException,
                                          AmazonServiceException

Send a batch of messages to users

Parameters:

sendUsersMessagesRequest -

Returns:

sendUsersMessagesResult The response from the SendUsersMessages service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

updateAdmChannel

UpdateAdmChannelResult updateAdmChannel(UpdateAdmChannelRequest updateAdmChannelRequest)
                                 throws AmazonClientException,
                                        AmazonServiceException

Update an ADM channel

Parameters:

updateAdmChannelRequest -

Returns:

updateAdmChannelResult The response from the UpdateAdmChannel service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

updateApnsChannel

UpdateApnsChannelResult updateApnsChannel(UpdateApnsChannelRequest updateApnsChannelRequest)
                                   throws AmazonClientException,
                                          AmazonServiceException

Use to update the APNs channel for an app.

Parameters:

updateApnsChannelRequest -

Returns:

updateApnsChannelResult The response from the UpdateApnsChannel service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

updateApnsSandboxChannel

UpdateApnsSandboxChannelResult updateApnsSandboxChannel(UpdateApnsSandboxChannelRequest updateApnsSandboxChannelRequest)
                                                 throws AmazonClientException,
                                                        AmazonServiceException

Update an APNS sandbox channel

Parameters:

updateApnsSandboxChannelRequest -

Returns:

updateApnsSandboxChannelResult The response from the UpdateApnsSandboxChannel service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

updateApnsVoipChannel

UpdateApnsVoipChannelResult updateApnsVoipChannel(UpdateApnsVoipChannelRequest updateApnsVoipChannelRequest)
                                           throws AmazonClientException,
                                                  AmazonServiceException

Update an APNS VoIP channel

Parameters:

updateApnsVoipChannelRequest -

Returns:

updateApnsVoipChannelResult The response from the UpdateApnsVoipChannel service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

updateApnsVoipSandboxChannel

UpdateApnsVoipSandboxChannelResult updateApnsVoipSandboxChannel(UpdateApnsVoipSandboxChannelRequest updateApnsVoipSandboxChannelRequest)
                                                         throws AmazonClientException,
                                                                AmazonServiceException

Update an APNS VoIP sandbox channel

Parameters:

updateApnsVoipSandboxChannelRequest -

Returns:

updateApnsVoipSandboxChannelResult The response from the UpdateApnsVoipSandboxChannel service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

updateApplicationSettings

UpdateApplicationSettingsResult updateApplicationSettings(UpdateApplicationSettingsRequest updateApplicationSettingsRequest)
                                                   throws AmazonClientException,
                                                          AmazonServiceException

Used to update the settings for an app.

Parameters:

updateApplicationSettingsRequest -

Returns:

updateApplicationSettingsResult The response from the UpdateApplicationSettings service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

updateBaiduChannel

UpdateBaiduChannelResult updateBaiduChannel(UpdateBaiduChannelRequest updateBaiduChannelRequest)
                                     throws AmazonClientException,
                                            AmazonServiceException

Update a BAIDU GCM channel

Parameters:

updateBaiduChannelRequest -

Returns:

updateBaiduChannelResult The response from the UpdateBaiduChannel service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

updateCampaign

UpdateCampaignResult updateCampaign(UpdateCampaignRequest updateCampaignRequest)
                             throws AmazonClientException,
                                    AmazonServiceException

Use to update a campaign.

Parameters:

updateCampaignRequest -

Returns:

updateCampaignResult The response from the UpdateCampaign service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

updateEmailChannel

UpdateEmailChannelResult updateEmailChannel(UpdateEmailChannelRequest updateEmailChannelRequest)
                                     throws AmazonClientException,
                                            AmazonServiceException

Update an email channel

Parameters:

updateEmailChannelRequest -

Returns:

updateEmailChannelResult The response from the UpdateEmailChannel service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

updateEndpoint

UpdateEndpointResult updateEndpoint(UpdateEndpointRequest updateEndpointRequest)
                             throws AmazonClientException,
                                    AmazonServiceException

Use to update an endpoint.

Parameters:

updateEndpointRequest -

Returns:

updateEndpointResult The response from the UpdateEndpoint service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

updateEndpointsBatch

UpdateEndpointsBatchResult updateEndpointsBatch(UpdateEndpointsBatchRequest updateEndpointsBatchRequest)
                                         throws AmazonClientException,
                                                AmazonServiceException

Use to update a batch of endpoints.

Parameters:

updateEndpointsBatchRequest -

Returns:

updateEndpointsBatchResult The response from the UpdateEndpointsBatch service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

updateGcmChannel

UpdateGcmChannelResult updateGcmChannel(UpdateGcmChannelRequest updateGcmChannelRequest)
                                 throws AmazonClientException,
                                        AmazonServiceException

Use to update the GCM channel for an app.

Parameters:

updateGcmChannelRequest -

Returns:

updateGcmChannelResult The response from the UpdateGcmChannel service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

updateSegment

UpdateSegmentResult updateSegment(UpdateSegmentRequest updateSegmentRequest)
                           throws AmazonClientException,
                                  AmazonServiceException

Use to update a segment.

Parameters:

updateSegmentRequest -

Returns:

updateSegmentResult The response from the UpdateSegment service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

updateSmsChannel

UpdateSmsChannelResult updateSmsChannel(UpdateSmsChannelRequest updateSmsChannelRequest)
                                 throws AmazonClientException,
                                        AmazonServiceException

Update an SMS channel

Parameters:

updateSmsChannelRequest -

Returns:

updateSmsChannelResult The response from the UpdateSmsChannel service method, as returned by AmazonPinpoint.

Throws:

BadRequestException

InternalServerErrorException

ForbiddenException

NotFoundException

MethodNotAllowedException

TooManyRequestsException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonPinpoint indicating either a problem with the data in the request, or a server side issue.

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.