com.amazonaws.services.pinpoint.AmazonPinpoint Maven / Gradle / Ivy
Show all versions of aws-android-sdk-pinpoint Show documentation
/*
* Copyright 2010-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.pinpoint;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.pinpoint.model.*;
/**
* Interface for accessing AmazonPinpoint
**/
public interface AmazonPinpoint {
/**
* 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
* {@link 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.
*
* @param 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.
*/
public void setEndpoint(String endpoint) throws java.lang.IllegalArgumentException;
/**
* An alternative to {@link AmazonPinpoint#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 {@link 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.
*
* @param region The region this client will communicate with. See
* {@link Region#getRegion(com.amazonaws.regions.Regions)} for
* accessing a given region.
* @throws java.lang.IllegalArgumentException If the given region is null,
* or if this service isn't available in the given region. See
* {@link Region#isServiceSupported(String)}
* @see Region#getRegion(com.amazonaws.regions.Regions)
* @see Region#createClient(Class,
* com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
*/
public void setRegion(Region region) throws java.lang.IllegalArgumentException;
/**
* Creates or updates an app.
*
* @param createAppRequest
* @return createAppResult The response from the CreateApp service method,
* as returned by AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
CreateAppResult createApp(CreateAppRequest createAppRequest) throws AmazonClientException,
AmazonServiceException;
/**
* Creates or updates a campaign.
*
* @param createCampaignRequest
* @return createCampaignResult The response from the CreateCampaign service
* method, as returned by AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
CreateCampaignResult createCampaign(CreateCampaignRequest createCampaignRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Creates an export job.
*
* @param createExportJobRequest
* @return createExportJobResult The response from the CreateExportJob
* service method, as returned by AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
CreateExportJobResult createExportJob(CreateExportJobRequest createExportJobRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Creates or updates an import job.
*
* @param createImportJobRequest
* @return createImportJobResult The response from the CreateImportJob
* service method, as returned by AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
CreateImportJobResult createImportJob(CreateImportJobRequest createImportJobRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Used to create or update a segment.
*
* @param createSegmentRequest
* @return createSegmentResult The response from the CreateSegment service
* method, as returned by AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
CreateSegmentResult createSegment(CreateSegmentRequest createSegmentRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Delete an ADM channel
*
* @param deleteAdmChannelRequest
* @return deleteAdmChannelResult The response from the DeleteAdmChannel
* service method, as returned by AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
DeleteAdmChannelResult deleteAdmChannel(DeleteAdmChannelRequest deleteAdmChannelRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Deletes the APNs channel for an app.
*
* @param deleteApnsChannelRequest
* @return deleteApnsChannelResult The response from the DeleteApnsChannel
* service method, as returned by AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
DeleteApnsChannelResult deleteApnsChannel(DeleteApnsChannelRequest deleteApnsChannelRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Delete an APNS sandbox channel
*
* @param deleteApnsSandboxChannelRequest
* @return deleteApnsSandboxChannelResult The response from the
* DeleteApnsSandboxChannel service method, as returned by
* AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
DeleteApnsSandboxChannelResult deleteApnsSandboxChannel(
DeleteApnsSandboxChannelRequest deleteApnsSandboxChannelRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Delete an APNS VoIP channel
*
* @param deleteApnsVoipChannelRequest
* @return deleteApnsVoipChannelResult The response from the
* DeleteApnsVoipChannel service method, as returned by
* AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
DeleteApnsVoipChannelResult deleteApnsVoipChannel(
DeleteApnsVoipChannelRequest deleteApnsVoipChannelRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Delete an APNS VoIP sandbox channel
*
* @param deleteApnsVoipSandboxChannelRequest
* @return deleteApnsVoipSandboxChannelResult The response from the
* DeleteApnsVoipSandboxChannel service method, as returned by
* AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
DeleteApnsVoipSandboxChannelResult deleteApnsVoipSandboxChannel(
DeleteApnsVoipSandboxChannelRequest deleteApnsVoipSandboxChannelRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Deletes an app.
*
* @param deleteAppRequest
* @return deleteAppResult The response from the DeleteApp service method,
* as returned by AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
DeleteAppResult deleteApp(DeleteAppRequest deleteAppRequest) throws AmazonClientException,
AmazonServiceException;
/**
* Delete a BAIDU GCM channel
*
* @param deleteBaiduChannelRequest
* @return deleteBaiduChannelResult The response from the DeleteBaiduChannel
* service method, as returned by AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
DeleteBaiduChannelResult deleteBaiduChannel(DeleteBaiduChannelRequest deleteBaiduChannelRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Deletes a campaign.
*
* @param deleteCampaignRequest
* @return deleteCampaignResult The response from the DeleteCampaign service
* method, as returned by AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
DeleteCampaignResult deleteCampaign(DeleteCampaignRequest deleteCampaignRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Delete an email channel
*
* @param deleteEmailChannelRequest
* @return deleteEmailChannelResult The response from the DeleteEmailChannel
* service method, as returned by AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
DeleteEmailChannelResult deleteEmailChannel(DeleteEmailChannelRequest deleteEmailChannelRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Deletes an endpoint.
*
* @param deleteEndpointRequest
* @return deleteEndpointResult The response from the DeleteEndpoint service
* method, as returned by AmazonPinpoint.
* @throws BadRequestException 400 response
* @throws InternalServerErrorException 500 response
* @throws ForbiddenException 403 response
* @throws NotFoundException 404 response
* @throws MethodNotAllowedException 405 response
* @throws TooManyRequestsException 429 response
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
DeleteEndpointResult deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Deletes the event stream for an app.
*
* @param deleteEventStreamRequest DeleteEventStream Request
* @return deleteEventStreamResult The response from the DeleteEventStream
* service method, as returned by AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
DeleteEventStreamResult deleteEventStream(DeleteEventStreamRequest deleteEventStreamRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Deletes the GCM channel for an app.
*
* @param deleteGcmChannelRequest
* @return deleteGcmChannelResult The response from the DeleteGcmChannel
* service method, as returned by AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
DeleteGcmChannelResult deleteGcmChannel(DeleteGcmChannelRequest deleteGcmChannelRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Deletes a segment.
*
* @param deleteSegmentRequest
* @return deleteSegmentResult The response from the DeleteSegment service
* method, as returned by AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
DeleteSegmentResult deleteSegment(DeleteSegmentRequest deleteSegmentRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Delete an SMS channel
*
* @param deleteSmsChannelRequest
* @return deleteSmsChannelResult The response from the DeleteSmsChannel
* service method, as returned by AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
DeleteSmsChannelResult deleteSmsChannel(DeleteSmsChannelRequest deleteSmsChannelRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Get an ADM channel
*
* @param getAdmChannelRequest
* @return getAdmChannelResult The response from the GetAdmChannel service
* method, as returned by AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
GetAdmChannelResult getAdmChannel(GetAdmChannelRequest getAdmChannelRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Returns information about the APNs channel for an app.
*
* @param getApnsChannelRequest
* @return getApnsChannelResult The response from the GetApnsChannel service
* method, as returned by AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
GetApnsChannelResult getApnsChannel(GetApnsChannelRequest getApnsChannelRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Get an APNS sandbox channel
*
* @param getApnsSandboxChannelRequest
* @return getApnsSandboxChannelResult The response from the
* GetApnsSandboxChannel service method, as returned by
* AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
GetApnsSandboxChannelResult getApnsSandboxChannel(
GetApnsSandboxChannelRequest getApnsSandboxChannelRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Get an APNS VoIP channel
*
* @param getApnsVoipChannelRequest
* @return getApnsVoipChannelResult The response from the GetApnsVoipChannel
* service method, as returned by AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
GetApnsVoipChannelResult getApnsVoipChannel(GetApnsVoipChannelRequest getApnsVoipChannelRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Get an APNS VoIPSandbox channel
*
* @param getApnsVoipSandboxChannelRequest
* @return getApnsVoipSandboxChannelResult The response from the
* GetApnsVoipSandboxChannel service method, as returned by
* AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
GetApnsVoipSandboxChannelResult getApnsVoipSandboxChannel(
GetApnsVoipSandboxChannelRequest getApnsVoipSandboxChannelRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Returns information about an app.
*
* @param getAppRequest
* @return getAppResult The response from the GetApp service method, as
* returned by AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
GetAppResult getApp(GetAppRequest getAppRequest) throws AmazonClientException,
AmazonServiceException;
/**
* Used to request the settings for an app.
*
* @param getApplicationSettingsRequest
* @return getApplicationSettingsResult The response from the
* GetApplicationSettings service method, as returned by
* AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
GetApplicationSettingsResult getApplicationSettings(
GetApplicationSettingsRequest getApplicationSettingsRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Returns information about your apps.
*
* @param getAppsRequest
* @return getAppsResult The response from the GetApps service method, as
* returned by AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
GetAppsResult getApps(GetAppsRequest getAppsRequest) throws AmazonClientException,
AmazonServiceException;
/**
* Get a BAIDU GCM channel
*
* @param getBaiduChannelRequest
* @return getBaiduChannelResult The response from the GetBaiduChannel
* service method, as returned by AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
GetBaiduChannelResult getBaiduChannel(GetBaiduChannelRequest getBaiduChannelRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Returns information about a campaign.
*
* @param getCampaignRequest
* @return getCampaignResult The response from the GetCampaign service
* method, as returned by AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
GetCampaignResult getCampaign(GetCampaignRequest getCampaignRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Returns information about the activity performed by a campaign.
*
* @param getCampaignActivitiesRequest
* @return getCampaignActivitiesResult The response from the
* GetCampaignActivities service method, as returned by
* AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
GetCampaignActivitiesResult getCampaignActivities(
GetCampaignActivitiesRequest getCampaignActivitiesRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Returns information about a specific version of a campaign.
*
* @param getCampaignVersionRequest
* @return getCampaignVersionResult The response from the GetCampaignVersion
* service method, as returned by AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
GetCampaignVersionResult getCampaignVersion(GetCampaignVersionRequest getCampaignVersionRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Returns information about your campaign versions.
*
* @param getCampaignVersionsRequest
* @return getCampaignVersionsResult The response from the
* GetCampaignVersions service method, as returned by
* AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
GetCampaignVersionsResult getCampaignVersions(
GetCampaignVersionsRequest getCampaignVersionsRequest) throws AmazonClientException,
AmazonServiceException;
/**
* Returns information about your campaigns.
*
* @param getCampaignsRequest
* @return getCampaignsResult The response from the GetCampaigns service
* method, as returned by AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
GetCampaignsResult getCampaigns(GetCampaignsRequest getCampaignsRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Get an email channel
*
* @param getEmailChannelRequest
* @return getEmailChannelResult The response from the GetEmailChannel
* service method, as returned by AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
GetEmailChannelResult getEmailChannel(GetEmailChannelRequest getEmailChannelRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Returns information about an endpoint.
*
* @param getEndpointRequest
* @return getEndpointResult The response from the GetEndpoint service
* method, as returned by AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
GetEndpointResult getEndpoint(GetEndpointRequest getEndpointRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Returns the event stream for an app.
*
* @param getEventStreamRequest GetEventStreamRequest
* @return getEventStreamResult The response from the GetEventStream service
* method, as returned by AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
GetEventStreamResult getEventStream(GetEventStreamRequest getEventStreamRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Returns information about an export job.
*
* @param getExportJobRequest
* @return getExportJobResult The response from the GetExportJob service
* method, as returned by AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
GetExportJobResult getExportJob(GetExportJobRequest getExportJobRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Returns information about your export jobs.
*
* @param getExportJobsRequest
* @return getExportJobsResult The response from the GetExportJobs service
* method, as returned by AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
GetExportJobsResult getExportJobs(GetExportJobsRequest getExportJobsRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Returns information about the GCM channel for an app.
*
* @param getGcmChannelRequest
* @return getGcmChannelResult The response from the GetGcmChannel service
* method, as returned by AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
GetGcmChannelResult getGcmChannel(GetGcmChannelRequest getGcmChannelRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Returns information about an import job.
*
* @param getImportJobRequest
* @return getImportJobResult The response from the GetImportJob service
* method, as returned by AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
GetImportJobResult getImportJob(GetImportJobRequest getImportJobRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Returns information about your import jobs.
*
* @param getImportJobsRequest
* @return getImportJobsResult The response from the GetImportJobs service
* method, as returned by AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
GetImportJobsResult getImportJobs(GetImportJobsRequest getImportJobsRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Returns information about a segment.
*
* @param getSegmentRequest
* @return getSegmentResult The response from the GetSegment service method,
* as returned by AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
GetSegmentResult getSegment(GetSegmentRequest getSegmentRequest) throws AmazonClientException,
AmazonServiceException;
/**
* Returns a list of export jobs for a specific segment.
*
* @param getSegmentExportJobsRequest
* @return getSegmentExportJobsResult The response from the
* GetSegmentExportJobs service method, as returned by
* AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
GetSegmentExportJobsResult getSegmentExportJobs(
GetSegmentExportJobsRequest getSegmentExportJobsRequest) throws AmazonClientException,
AmazonServiceException;
/**
* Returns a list of import jobs for a specific segment.
*
* @param getSegmentImportJobsRequest
* @return getSegmentImportJobsResult The response from the
* GetSegmentImportJobs service method, as returned by
* AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
GetSegmentImportJobsResult getSegmentImportJobs(
GetSegmentImportJobsRequest getSegmentImportJobsRequest) throws AmazonClientException,
AmazonServiceException;
/**
* Returns information about a segment version.
*
* @param getSegmentVersionRequest
* @return getSegmentVersionResult The response from the GetSegmentVersion
* service method, as returned by AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
GetSegmentVersionResult getSegmentVersion(GetSegmentVersionRequest getSegmentVersionRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Returns information about your segment versions.
*
* @param getSegmentVersionsRequest
* @return getSegmentVersionsResult The response from the GetSegmentVersions
* service method, as returned by AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
GetSegmentVersionsResult getSegmentVersions(GetSegmentVersionsRequest getSegmentVersionsRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Used to get information about your segments.
*
* @param getSegmentsRequest
* @return getSegmentsResult The response from the GetSegments service
* method, as returned by AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
GetSegmentsResult getSegments(GetSegmentsRequest getSegmentsRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Get an SMS channel
*
* @param getSmsChannelRequest
* @return getSmsChannelResult The response from the GetSmsChannel service
* method, as returned by AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
GetSmsChannelResult getSmsChannel(GetSmsChannelRequest getSmsChannelRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Use to create or update the event stream for an app.
*
* @param putEventStreamRequest
* @return putEventStreamResult The response from the PutEventStream service
* method, as returned by AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
PutEventStreamResult putEventStream(PutEventStreamRequest putEventStreamRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Send a batch of messages
*
* @param sendMessagesRequest
* @return sendMessagesResult The response from the SendMessages service
* method, as returned by AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
SendMessagesResult sendMessages(SendMessagesRequest sendMessagesRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Send a batch of messages to users
*
* @param sendUsersMessagesRequest
* @return sendUsersMessagesResult The response from the SendUsersMessages
* service method, as returned by AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
SendUsersMessagesResult sendUsersMessages(SendUsersMessagesRequest sendUsersMessagesRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Update an ADM channel
*
* @param updateAdmChannelRequest
* @return updateAdmChannelResult The response from the UpdateAdmChannel
* service method, as returned by AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
UpdateAdmChannelResult updateAdmChannel(UpdateAdmChannelRequest updateAdmChannelRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Use to update the APNs channel for an app.
*
* @param updateApnsChannelRequest
* @return updateApnsChannelResult The response from the UpdateApnsChannel
* service method, as returned by AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
UpdateApnsChannelResult updateApnsChannel(UpdateApnsChannelRequest updateApnsChannelRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Update an APNS sandbox channel
*
* @param updateApnsSandboxChannelRequest
* @return updateApnsSandboxChannelResult The response from the
* UpdateApnsSandboxChannel service method, as returned by
* AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
UpdateApnsSandboxChannelResult updateApnsSandboxChannel(
UpdateApnsSandboxChannelRequest updateApnsSandboxChannelRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Update an APNS VoIP channel
*
* @param updateApnsVoipChannelRequest
* @return updateApnsVoipChannelResult The response from the
* UpdateApnsVoipChannel service method, as returned by
* AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
UpdateApnsVoipChannelResult updateApnsVoipChannel(
UpdateApnsVoipChannelRequest updateApnsVoipChannelRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Update an APNS VoIP sandbox channel
*
* @param updateApnsVoipSandboxChannelRequest
* @return updateApnsVoipSandboxChannelResult The response from the
* UpdateApnsVoipSandboxChannel service method, as returned by
* AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
UpdateApnsVoipSandboxChannelResult updateApnsVoipSandboxChannel(
UpdateApnsVoipSandboxChannelRequest updateApnsVoipSandboxChannelRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Used to update the settings for an app.
*
* @param updateApplicationSettingsRequest
* @return updateApplicationSettingsResult The response from the
* UpdateApplicationSettings service method, as returned by
* AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
UpdateApplicationSettingsResult updateApplicationSettings(
UpdateApplicationSettingsRequest updateApplicationSettingsRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Update a BAIDU GCM channel
*
* @param updateBaiduChannelRequest
* @return updateBaiduChannelResult The response from the UpdateBaiduChannel
* service method, as returned by AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
UpdateBaiduChannelResult updateBaiduChannel(UpdateBaiduChannelRequest updateBaiduChannelRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Use to update a campaign.
*
* @param updateCampaignRequest
* @return updateCampaignResult The response from the UpdateCampaign service
* method, as returned by AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
UpdateCampaignResult updateCampaign(UpdateCampaignRequest updateCampaignRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Update an email channel
*
* @param updateEmailChannelRequest
* @return updateEmailChannelResult The response from the UpdateEmailChannel
* service method, as returned by AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
UpdateEmailChannelResult updateEmailChannel(UpdateEmailChannelRequest updateEmailChannelRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Use to update an endpoint.
*
* @param updateEndpointRequest
* @return updateEndpointResult The response from the UpdateEndpoint service
* method, as returned by AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
UpdateEndpointResult updateEndpoint(UpdateEndpointRequest updateEndpointRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Use to update a batch of endpoints.
*
* @param updateEndpointsBatchRequest
* @return updateEndpointsBatchResult The response from the
* UpdateEndpointsBatch service method, as returned by
* AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
UpdateEndpointsBatchResult updateEndpointsBatch(
UpdateEndpointsBatchRequest updateEndpointsBatchRequest) throws AmazonClientException,
AmazonServiceException;
/**
* Use to update the GCM channel for an app.
*
* @param updateGcmChannelRequest
* @return updateGcmChannelResult The response from the UpdateGcmChannel
* service method, as returned by AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
UpdateGcmChannelResult updateGcmChannel(UpdateGcmChannelRequest updateGcmChannelRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Use to update a segment.
*
* @param updateSegmentRequest
* @return updateSegmentResult The response from the UpdateSegment service
* method, as returned by AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
UpdateSegmentResult updateSegment(UpdateSegmentRequest updateSegmentRequest)
throws AmazonClientException, AmazonServiceException;
/**
* Update an SMS channel
*
* @param updateSmsChannelRequest
* @return updateSmsChannelResult The response from the UpdateSmsChannel
* service method, as returned by AmazonPinpoint.
* @throws BadRequestException
* @throws InternalServerErrorException
* @throws ForbiddenException
* @throws NotFoundException
* @throws MethodNotAllowedException
* @throws TooManyRequestsException
* @throws 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.
* @throws AmazonServiceException If an error response is returned by
* AmazonPinpoint indicating either a problem with the data in
* the request, or a server side issue.
*/
UpdateSmsChannelResult updateSmsChannel(UpdateSmsChannelRequest updateSmsChannelRequest)
throws AmazonClientException, AmazonServiceException;
/**
* 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.
*/
public void shutdown();
/**
* 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.
*
* @param request The originally executed request.
* @return The response metadata for the specified request, or null if none
* is available.
*/
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}