com.amazonaws.services.pinpoint

Interface AmazonPinpoint

All Known Subinterfaces:

AmazonPinpointAsync

All Known Implementing Classes:

AbstractAmazonPinpoint, AbstractAmazonPinpointAsync, AmazonPinpointAsyncClient, AmazonPinpointClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonPinpoint

Interface for accessing Amazon Pinpoint.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonPinpoint instead.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

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.
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
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.
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.
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) Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
void	setRegion(Region region) Deprecated. use AwsClientBuilder#setRegion(String)
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

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

setEndpoint

@Deprecated
void setEndpoint(String endpoint)

Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));

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.

setRegion

@Deprecated
void setRegion(Region region)

Deprecated. use AwsClientBuilder#setRegion(String)

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. Must not be null and must be a region where the service is available.

See Also:

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

createApp

CreateAppResult createApp(CreateAppRequest createAppRequest)

Creates or updates an app.

Parameters:

createAppRequest -

Returns:

Result of the CreateApp operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

createCampaign

CreateCampaignResult createCampaign(CreateCampaignRequest createCampaignRequest)

Creates or updates a campaign.

Parameters:

createCampaignRequest -

Returns:

Result of the CreateCampaign operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

createImportJob

CreateImportJobResult createImportJob(CreateImportJobRequest createImportJobRequest)

Creates or updates an import job.

Parameters:

createImportJobRequest -

Returns:

Result of the CreateImportJob operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

createSegment

CreateSegmentResult createSegment(CreateSegmentRequest createSegmentRequest)

Used to create or update a segment.

Parameters:

createSegmentRequest -

Returns:

Result of the CreateSegment operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

deleteAdmChannel

DeleteAdmChannelResult deleteAdmChannel(DeleteAdmChannelRequest deleteAdmChannelRequest)

Delete an ADM channel

Parameters:

deleteAdmChannelRequest -

Returns:

Result of the DeleteAdmChannel operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

deleteApnsChannel

DeleteApnsChannelResult deleteApnsChannel(DeleteApnsChannelRequest deleteApnsChannelRequest)

Deletes the APNs channel for an app.

Parameters:

deleteApnsChannelRequest -

Returns:

Result of the DeleteApnsChannel operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

deleteApnsSandboxChannel

DeleteApnsSandboxChannelResult deleteApnsSandboxChannel(DeleteApnsSandboxChannelRequest deleteApnsSandboxChannelRequest)

Delete an APNS sandbox channel

Parameters:

deleteApnsSandboxChannelRequest -

Returns:

Result of the DeleteApnsSandboxChannel operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

deleteApnsVoipChannel

DeleteApnsVoipChannelResult deleteApnsVoipChannel(DeleteApnsVoipChannelRequest deleteApnsVoipChannelRequest)

Delete an APNS VoIP channel

Parameters:

deleteApnsVoipChannelRequest -

Returns:

Result of the DeleteApnsVoipChannel operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

deleteApnsVoipSandboxChannel

DeleteApnsVoipSandboxChannelResult deleteApnsVoipSandboxChannel(DeleteApnsVoipSandboxChannelRequest deleteApnsVoipSandboxChannelRequest)

Delete an APNS VoIP sandbox channel

Parameters:

deleteApnsVoipSandboxChannelRequest -

Returns:

Result of the DeleteApnsVoipSandboxChannel operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

deleteApp

DeleteAppResult deleteApp(DeleteAppRequest deleteAppRequest)

Deletes an app.

Parameters:

deleteAppRequest -

Returns:

Result of the DeleteApp operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

deleteBaiduChannel

DeleteBaiduChannelResult deleteBaiduChannel(DeleteBaiduChannelRequest deleteBaiduChannelRequest)

Delete a BAIDU GCM channel

Parameters:

deleteBaiduChannelRequest -

Returns:

Result of the DeleteBaiduChannel operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

deleteCampaign

DeleteCampaignResult deleteCampaign(DeleteCampaignRequest deleteCampaignRequest)

Deletes a campaign.

Parameters:

deleteCampaignRequest -

Returns:

Result of the DeleteCampaign operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

deleteEmailChannel

DeleteEmailChannelResult deleteEmailChannel(DeleteEmailChannelRequest deleteEmailChannelRequest)

Delete an email channel

Parameters:

deleteEmailChannelRequest -

Returns:

Result of the DeleteEmailChannel operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

deleteEventStream

DeleteEventStreamResult deleteEventStream(DeleteEventStreamRequest deleteEventStreamRequest)

Deletes the event stream for an app.

Parameters:

deleteEventStreamRequest - DeleteEventStream Request

Returns:

Result of the DeleteEventStream operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

deleteGcmChannel

DeleteGcmChannelResult deleteGcmChannel(DeleteGcmChannelRequest deleteGcmChannelRequest)

Deletes the GCM channel for an app.

Parameters:

deleteGcmChannelRequest -

Returns:

Result of the DeleteGcmChannel operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

deleteSegment

DeleteSegmentResult deleteSegment(DeleteSegmentRequest deleteSegmentRequest)

Deletes a segment.

Parameters:

deleteSegmentRequest -

Returns:

Result of the DeleteSegment operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

deleteSmsChannel

DeleteSmsChannelResult deleteSmsChannel(DeleteSmsChannelRequest deleteSmsChannelRequest)

Delete an SMS channel

Parameters:

deleteSmsChannelRequest -

Returns:

Result of the DeleteSmsChannel operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

getAdmChannel

GetAdmChannelResult getAdmChannel(GetAdmChannelRequest getAdmChannelRequest)

Get an ADM channel

Parameters:

getAdmChannelRequest -

Returns:

Result of the GetAdmChannel operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

getApnsChannel

GetApnsChannelResult getApnsChannel(GetApnsChannelRequest getApnsChannelRequest)

Returns information about the APNs channel for an app.

Parameters:

getApnsChannelRequest -

Returns:

Result of the GetApnsChannel operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

getApnsSandboxChannel

GetApnsSandboxChannelResult getApnsSandboxChannel(GetApnsSandboxChannelRequest getApnsSandboxChannelRequest)

Get an APNS sandbox channel

Parameters:

getApnsSandboxChannelRequest -

Returns:

Result of the GetApnsSandboxChannel operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

getApnsVoipChannel

GetApnsVoipChannelResult getApnsVoipChannel(GetApnsVoipChannelRequest getApnsVoipChannelRequest)

Get an APNS VoIP channel

Parameters:

getApnsVoipChannelRequest -

Returns:

Result of the GetApnsVoipChannel operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

getApnsVoipSandboxChannel

GetApnsVoipSandboxChannelResult getApnsVoipSandboxChannel(GetApnsVoipSandboxChannelRequest getApnsVoipSandboxChannelRequest)

Get an APNS VoipSandbox channel

Parameters:

getApnsVoipSandboxChannelRequest -

Returns:

Result of the GetApnsVoipSandboxChannel operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

getApp

GetAppResult getApp(GetAppRequest getAppRequest)

Returns information about an app.

Parameters:

getAppRequest -

Returns:

Result of the GetApp operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

getApplicationSettings

GetApplicationSettingsResult getApplicationSettings(GetApplicationSettingsRequest getApplicationSettingsRequest)

Used to request the settings for an app.

Parameters:

getApplicationSettingsRequest -

Returns:

Result of the GetApplicationSettings operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

getApps

GetAppsResult getApps(GetAppsRequest getAppsRequest)

Returns information about your apps.

Parameters:

getAppsRequest -

Returns:

Result of the GetApps operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

getBaiduChannel

GetBaiduChannelResult getBaiduChannel(GetBaiduChannelRequest getBaiduChannelRequest)

Get a BAIDU GCM channel

Parameters:

getBaiduChannelRequest -

Returns:

Result of the GetBaiduChannel operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

getCampaign

GetCampaignResult getCampaign(GetCampaignRequest getCampaignRequest)

Returns information about a campaign.

Parameters:

getCampaignRequest -

Returns:

Result of the GetCampaign operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

getCampaignActivities

GetCampaignActivitiesResult getCampaignActivities(GetCampaignActivitiesRequest getCampaignActivitiesRequest)

Returns information about the activity performed by a campaign.

Parameters:

getCampaignActivitiesRequest -

Returns:

Result of the GetCampaignActivities operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

getCampaignVersion

GetCampaignVersionResult getCampaignVersion(GetCampaignVersionRequest getCampaignVersionRequest)

Returns information about a specific version of a campaign.

Parameters:

getCampaignVersionRequest -

Returns:

Result of the GetCampaignVersion operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

getCampaignVersions

GetCampaignVersionsResult getCampaignVersions(GetCampaignVersionsRequest getCampaignVersionsRequest)

Returns information about your campaign versions.

Parameters:

getCampaignVersionsRequest -

Returns:

Result of the GetCampaignVersions operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

getCampaigns

GetCampaignsResult getCampaigns(GetCampaignsRequest getCampaignsRequest)

Returns information about your campaigns.

Parameters:

getCampaignsRequest -

Returns:

Result of the GetCampaigns operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

getEmailChannel

GetEmailChannelResult getEmailChannel(GetEmailChannelRequest getEmailChannelRequest)

Get an email channel

Parameters:

getEmailChannelRequest -

Returns:

Result of the GetEmailChannel operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

getEndpoint

GetEndpointResult getEndpoint(GetEndpointRequest getEndpointRequest)

Returns information about an endpoint.

Parameters:

getEndpointRequest -

Returns:

Result of the GetEndpoint operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

getEventStream

GetEventStreamResult getEventStream(GetEventStreamRequest getEventStreamRequest)

Returns the event stream for an app.

Parameters:

getEventStreamRequest - GetEventStreamRequest

Returns:

Result of the GetEventStream operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

getGcmChannel

GetGcmChannelResult getGcmChannel(GetGcmChannelRequest getGcmChannelRequest)

Returns information about the GCM channel for an app.

Parameters:

getGcmChannelRequest -

Returns:

Result of the GetGcmChannel operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

getImportJob

GetImportJobResult getImportJob(GetImportJobRequest getImportJobRequest)

Returns information about an import job.

Parameters:

getImportJobRequest -

Returns:

Result of the GetImportJob operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

getImportJobs

GetImportJobsResult getImportJobs(GetImportJobsRequest getImportJobsRequest)

Returns information about your import jobs.

Parameters:

getImportJobsRequest -

Returns:

Result of the GetImportJobs operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

getSegment

GetSegmentResult getSegment(GetSegmentRequest getSegmentRequest)

Returns information about a segment.

Parameters:

getSegmentRequest -

Returns:

Result of the GetSegment operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

getSegmentImportJobs

GetSegmentImportJobsResult getSegmentImportJobs(GetSegmentImportJobsRequest getSegmentImportJobsRequest)

Returns a list of import jobs for a specific segment.

Parameters:

getSegmentImportJobsRequest -

Returns:

Result of the GetSegmentImportJobs operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

getSegmentVersion

GetSegmentVersionResult getSegmentVersion(GetSegmentVersionRequest getSegmentVersionRequest)

Returns information about a segment version.

Parameters:

getSegmentVersionRequest -

Returns:

Result of the GetSegmentVersion operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

getSegmentVersions

GetSegmentVersionsResult getSegmentVersions(GetSegmentVersionsRequest getSegmentVersionsRequest)

Returns information about your segment versions.

Parameters:

getSegmentVersionsRequest -

Returns:

Result of the GetSegmentVersions operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

getSegments

GetSegmentsResult getSegments(GetSegmentsRequest getSegmentsRequest)

Used to get information about your segments.

Parameters:

getSegmentsRequest -

Returns:

Result of the GetSegments operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

getSmsChannel

GetSmsChannelResult getSmsChannel(GetSmsChannelRequest getSmsChannelRequest)

Get an SMS channel

Parameters:

getSmsChannelRequest -

Returns:

Result of the GetSmsChannel operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

putEventStream

PutEventStreamResult putEventStream(PutEventStreamRequest putEventStreamRequest)

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

Parameters:

putEventStreamRequest -

Returns:

Result of the PutEventStream operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

sendMessages

SendMessagesResult sendMessages(SendMessagesRequest sendMessagesRequest)

Send a batch of messages

Parameters:

sendMessagesRequest -

Returns:

Result of the SendMessages operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

sendUsersMessages

SendUsersMessagesResult sendUsersMessages(SendUsersMessagesRequest sendUsersMessagesRequest)

Send a batch of messages to users

Parameters:

sendUsersMessagesRequest -

Returns:

Result of the SendUsersMessages operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

updateAdmChannel

UpdateAdmChannelResult updateAdmChannel(UpdateAdmChannelRequest updateAdmChannelRequest)

Update an ADM channel

Parameters:

updateAdmChannelRequest -

Returns:

Result of the UpdateAdmChannel operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

updateApnsChannel

UpdateApnsChannelResult updateApnsChannel(UpdateApnsChannelRequest updateApnsChannelRequest)

Use to update the APNs channel for an app.

Parameters:

updateApnsChannelRequest -

Returns:

Result of the UpdateApnsChannel operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

updateApnsSandboxChannel

UpdateApnsSandboxChannelResult updateApnsSandboxChannel(UpdateApnsSandboxChannelRequest updateApnsSandboxChannelRequest)

Update an APNS sandbox channel

Parameters:

updateApnsSandboxChannelRequest -

Returns:

Result of the UpdateApnsSandboxChannel operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

updateApnsVoipChannel

UpdateApnsVoipChannelResult updateApnsVoipChannel(UpdateApnsVoipChannelRequest updateApnsVoipChannelRequest)

Update an APNS VoIP channel

Parameters:

updateApnsVoipChannelRequest -

Returns:

Result of the UpdateApnsVoipChannel operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

updateApnsVoipSandboxChannel

UpdateApnsVoipSandboxChannelResult updateApnsVoipSandboxChannel(UpdateApnsVoipSandboxChannelRequest updateApnsVoipSandboxChannelRequest)

Update an APNS VoIP sandbox channel

Parameters:

updateApnsVoipSandboxChannelRequest -

Returns:

Result of the UpdateApnsVoipSandboxChannel operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

updateApplicationSettings

UpdateApplicationSettingsResult updateApplicationSettings(UpdateApplicationSettingsRequest updateApplicationSettingsRequest)

Used to update the settings for an app.

Parameters:

updateApplicationSettingsRequest -

Returns:

Result of the UpdateApplicationSettings operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

updateBaiduChannel

UpdateBaiduChannelResult updateBaiduChannel(UpdateBaiduChannelRequest updateBaiduChannelRequest)

Update a BAIDU GCM channel

Parameters:

updateBaiduChannelRequest -

Returns:

Result of the UpdateBaiduChannel operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

updateCampaign

UpdateCampaignResult updateCampaign(UpdateCampaignRequest updateCampaignRequest)

Use to update a campaign.

Parameters:

updateCampaignRequest -

Returns:

Result of the UpdateCampaign operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

updateEmailChannel

UpdateEmailChannelResult updateEmailChannel(UpdateEmailChannelRequest updateEmailChannelRequest)

Update an email channel

Parameters:

updateEmailChannelRequest -

Returns:

Result of the UpdateEmailChannel operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

updateEndpoint

UpdateEndpointResult updateEndpoint(UpdateEndpointRequest updateEndpointRequest)

Use to update an endpoint.

Parameters:

updateEndpointRequest -

Returns:

Result of the UpdateEndpoint operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

updateEndpointsBatch

UpdateEndpointsBatchResult updateEndpointsBatch(UpdateEndpointsBatchRequest updateEndpointsBatchRequest)

Use to update a batch of endpoints.

Parameters:

updateEndpointsBatchRequest -

Returns:

Result of the UpdateEndpointsBatch operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

updateGcmChannel

UpdateGcmChannelResult updateGcmChannel(UpdateGcmChannelRequest updateGcmChannelRequest)

Use to update the GCM channel for an app.

Parameters:

updateGcmChannelRequest -

Returns:

Result of the UpdateGcmChannel operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

updateSegment

UpdateSegmentResult updateSegment(UpdateSegmentRequest updateSegmentRequest)

Use to update a segment.

Parameters:

updateSegmentRequest -

Returns:

Result of the UpdateSegment operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

updateSmsChannel

UpdateSmsChannelResult updateSmsChannel(UpdateSmsChannelRequest updateSmsChannelRequest)

Update an SMS channel

Parameters:

updateSmsChannelRequest -

Returns:

Result of the UpdateSmsChannel operation returned by the service.

Throws:

BadRequestException - Simple message object.

InternalServerErrorException - Simple message object.

ForbiddenException - Simple message object.

NotFoundException - Simple message object.

MethodNotAllowedException - Simple message object.

TooManyRequestsException - Simple message object.

See Also:

AWS API Documentation

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.