com.amazonaws.services.pinpoint

Class AmazonPinpointClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.pinpoint.AmazonPinpointClient

All Implemented Interfaces:

AmazonPinpoint

public class AmazonPinpointClient
extends AmazonWebServiceClient
implements AmazonPinpoint

Client for accessing AmazonPinpoint. All service calls made using this client are blocking, and will not return until the service call completes.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<com.amazonaws.transform.JsonErrorUnmarshaller>	jsonErrorUnmarshallers List of exception unmarshallers for all AmazonPinpoint exceptions.

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Constructor Summary

Constructors

Constructor and Description
AmazonPinpointClient() Deprecated.
AmazonPinpointClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on AmazonPinpoint using the specified AWS account credentials.
AmazonPinpointClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonPinpoint using the specified AWS account credentials and client configuration options.
AmazonPinpointClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on AmazonPinpoint using the specified AWS account credentials provider.
AmazonPinpointClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonPinpoint using the specified AWS account credentials provider and client configuration options.
AmazonPinpointClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, HttpClient httpClient) Constructs a new client to invoke service methods on AmazonPinpoint using the specified AWS account credentials provider, client configuration options and request metric collector.
AmazonPinpointClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Deprecated.
AmazonPinpointClient(ClientConfiguration clientConfiguration) Deprecated.

Method Summary

Modifier and Type	Method and Description
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.
DeleteApnsChannelResult	deleteApnsChannel(DeleteApnsChannelRequest deleteApnsChannelRequest) Deletes the APNs channel for an app.
DeleteCampaignResult	deleteCampaign(DeleteCampaignRequest deleteCampaignRequest) Deletes a campaign.
DeleteGcmChannelResult	deleteGcmChannel(DeleteGcmChannelRequest deleteGcmChannelRequest) Deletes the GCM channel for an app.
DeleteSegmentResult	deleteSegment(DeleteSegmentRequest deleteSegmentRequest) Deletes a segment.
GetApnsChannelResult	getApnsChannel(GetApnsChannelRequest getApnsChannelRequest) Returns information about the APNs channel for an app.
GetApplicationSettingsResult	getApplicationSettings(GetApplicationSettingsRequest getApplicationSettingsRequest) Used to request the settings for an app.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Deprecated. ResponseMetadata cache can hold up to 50 requests and responses in memory and will cause memory issue. This method now always returns null.
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 your campaign versions.
GetCampaignVersionsResult	getCampaignVersions(GetCampaignVersionsRequest getCampaignVersionsRequest) Returns information about your campaign versions.
GetEndpointResult	getEndpoint(GetEndpointRequest getEndpointRequest) Returns information about an endpoint.
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.
UpdateApnsChannelResult	updateApnsChannel(UpdateApnsChannelRequest updateApnsChannelRequest) Use to update the APNs channel for an app.
UpdateApplicationSettingsResult	updateApplicationSettings(UpdateApplicationSettingsRequest updateApplicationSettingsRequest) Used to update the settings for an app.
UpdateCampaignResult	updateCampaign(UpdateCampaignRequest updateCampaignRequest) Use to update a campaign.
UpdateEndpointResult	updateEndpoint(UpdateEndpointRequest updateEndpointRequest) Use to update an endpoint.
UpdateEndpointsBatchResult	updateEndpointsBatch(UpdateEndpointsBatchRequest updateEndpointsBatchRequest) Use to update your endpoints.
UpdateGcmChannelResult	updateGcmChannel(UpdateGcmChannelRequest updateGcmChannelRequest) Use to update the GCM channel for an app.
UpdateSegmentResult	updateSegment(UpdateSegmentRequest updateSegmentRequest) Use to update a segment.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configSigner, configSigner, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setConfiguration, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.pinpoint.AmazonPinpoint

setEndpoint, setRegion, shutdown

Field Detail

jsonErrorUnmarshallers

protected List<com.amazonaws.transform.JsonErrorUnmarshaller> jsonErrorUnmarshallers

List of exception unmarshallers for all AmazonPinpoint exceptions.

Constructor Detail

AmazonPinpointClient

@Deprecated
public AmazonPinpointClient()

Deprecated.

Constructs a new client to invoke service methods on AmazonPinpoint. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AmazonPinpointClient

@Deprecated
public AmazonPinpointClient(ClientConfiguration clientConfiguration)

Deprecated.

Constructs a new client to invoke service methods on AmazonPinpoint. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to AmazonPinpoint (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AmazonPinpointClient

public AmazonPinpointClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on AmazonPinpoint using the specified AWS account credentials.

If AWS session credentials are passed in, then those credentials will be used to authenticate requests. Otherwise, if AWS long-term credentials are passed in, then session management will be handled automatically by the SDK. Callers are encouraged to use long-term credentials and let the SDK handle starting and renewing sessions.

Automatically managed sessions will be shared among all clients that use the same credentials and service endpoint. To opt out of this behavior, explicitly provide an instance of AWSCredentialsProvider that returns AWSSessionCredentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AmazonPinpointClient

public AmazonPinpointClient(AWSCredentials awsCredentials,
                            ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonPinpoint using the specified AWS account credentials and client configuration options.

If AWS session credentials are passed in, then those credentials will be used to authenticate requests. Otherwise, if AWS long-term credentials are passed in, then session management will be handled automatically by the SDK. Callers are encouraged to use long-term credentials and let the SDK handle starting and renewing sessions.

Automatically managed sessions will be shared among all clients that use the same credentials and service endpoint. To opt out of this behavior, explicitly provide an instance of AWSCredentialsProvider that returns AWSSessionCredentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonPinpoint (ex: proxy settings, retry counts, etc.).

AmazonPinpointClient

public AmazonPinpointClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on AmazonPinpoint using the specified AWS account credentials provider.

If AWS session credentials are passed in, then those credentials will be used to authenticate requests. Otherwise, if AWS long-term credentials are passed in, then session management will be handled automatically by the SDK. Callers are encouraged to use long-term credentials and let the SDK handle starting and renewing sessions.

Automatically managed sessions will be shared among all clients that use the same credentials and service endpoint. To opt out of this behavior, explicitly provide an instance of AWSCredentialsProvider that returns AWSSessionCredentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AmazonPinpointClient

public AmazonPinpointClient(AWSCredentialsProvider awsCredentialsProvider,
                            ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonPinpoint using the specified AWS account credentials provider and client configuration options.

If AWS session credentials are passed in, then those credentials will be used to authenticate requests. Otherwise, if AWS long-term credentials are passed in, then session management will be handled automatically by the SDK. Callers are encouraged to use long-term credentials and let the SDK handle starting and renewing sessions.

Automatically managed sessions will be shared among all clients that use the same credentials and service endpoint. To opt out of this behavior, explicitly provide an instance of AWSCredentialsProvider that returns AWSSessionCredentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonPinpoint (ex: proxy settings, retry counts, etc.).

AmazonPinpointClient

@Deprecated
public AmazonPinpointClient(AWSCredentialsProvider awsCredentialsProvider,
                                        ClientConfiguration clientConfiguration,
                                        RequestMetricCollector requestMetricCollector)

Deprecated.

Constructs a new client to invoke service methods on AmazonPinpoint using the specified AWS account credentials provider, client configuration options and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonPinpoint (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

AmazonPinpointClient

public AmazonPinpointClient(AWSCredentialsProvider awsCredentialsProvider,
                            ClientConfiguration clientConfiguration,
                            HttpClient httpClient)

Constructs a new client to invoke service methods on AmazonPinpoint using the specified AWS account credentials provider, client configuration options and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonPinpoint (ex: proxy settings, retry counts, etc.).

httpClient - A http client

Method Detail

createCampaign

public CreateCampaignResult createCampaign(CreateCampaignRequest createCampaignRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

Creates or updates a campaign.

Specified by:

createCampaign in interface AmazonPinpoint

Parameters:

createCampaignRequest -

Returns:

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

Throws:

BadRequestException - 400 response

InternalServerErrorException - 500 response

ForbiddenException - 403 response

NotFoundException - 404 response

MethodNotAllowedException - 405 response

TooManyRequestsException - 429 response

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

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

createImportJob

public CreateImportJobResult createImportJob(CreateImportJobRequest createImportJobRequest)
                                      throws AmazonServiceException,
                                             AmazonClientException

Creates or updates an import job.

Specified by:

createImportJob in interface AmazonPinpoint

Parameters:

createImportJobRequest -

Returns:

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

Throws:

BadRequestException - 400 response

InternalServerErrorException - 500 response

ForbiddenException - 403 response

NotFoundException - 404 response

MethodNotAllowedException - 405 response

TooManyRequestsException - 429 response

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

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

createSegment

public CreateSegmentResult createSegment(CreateSegmentRequest createSegmentRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

Used to create or update a segment.

Specified by:

createSegment in interface AmazonPinpoint

Parameters:

createSegmentRequest -

Returns:

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

Throws:

BadRequestException - 400 response

InternalServerErrorException - 500 response

ForbiddenException - 403 response

NotFoundException - 404 response

MethodNotAllowedException - 405 response

TooManyRequestsException - 429 response

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

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

deleteApnsChannel

public DeleteApnsChannelResult deleteApnsChannel(DeleteApnsChannelRequest deleteApnsChannelRequest)
                                          throws AmazonServiceException,
                                                 AmazonClientException

Deletes the APNs channel for an app.

Specified by:

deleteApnsChannel in interface AmazonPinpoint

Parameters:

deleteApnsChannelRequest -

Returns:

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

Throws:

BadRequestException - 400 response

InternalServerErrorException - 500 response

ForbiddenException - 403 response

NotFoundException - 404 response

MethodNotAllowedException - 405 response

TooManyRequestsException - 429 response

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

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

deleteCampaign

public DeleteCampaignResult deleteCampaign(DeleteCampaignRequest deleteCampaignRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

Deletes a campaign.

Specified by:

deleteCampaign in interface AmazonPinpoint

Parameters:

deleteCampaignRequest -

Returns:

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

Throws:

BadRequestException - 400 response

InternalServerErrorException - 500 response

ForbiddenException - 403 response

NotFoundException - 404 response

MethodNotAllowedException - 405 response

TooManyRequestsException - 429 response

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

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

deleteGcmChannel

public DeleteGcmChannelResult deleteGcmChannel(DeleteGcmChannelRequest deleteGcmChannelRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

Deletes the GCM channel for an app.

Specified by:

deleteGcmChannel in interface AmazonPinpoint

Parameters:

deleteGcmChannelRequest -

Returns:

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

Throws:

BadRequestException - 400 response

InternalServerErrorException - 500 response

ForbiddenException - 403 response

NotFoundException - 404 response

MethodNotAllowedException - 405 response

TooManyRequestsException - 429 response

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

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

deleteSegment

public DeleteSegmentResult deleteSegment(DeleteSegmentRequest deleteSegmentRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

Deletes a segment.

Specified by:

deleteSegment in interface AmazonPinpoint

Parameters:

deleteSegmentRequest -

Returns:

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

Throws:

BadRequestException - 400 response

InternalServerErrorException - 500 response

ForbiddenException - 403 response

NotFoundException - 404 response

MethodNotAllowedException - 405 response

TooManyRequestsException - 429 response

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

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

getApnsChannel

public GetApnsChannelResult getApnsChannel(GetApnsChannelRequest getApnsChannelRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

Returns information about the APNs channel for an app.

Specified by:

getApnsChannel in interface AmazonPinpoint

Parameters:

getApnsChannelRequest -

Returns:

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

Throws:

BadRequestException - 400 response

InternalServerErrorException - 500 response

ForbiddenException - 403 response

NotFoundException - 404 response

MethodNotAllowedException - 405 response

TooManyRequestsException - 429 response

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

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

getApplicationSettings

public GetApplicationSettingsResult getApplicationSettings(GetApplicationSettingsRequest getApplicationSettingsRequest)
                                                    throws AmazonServiceException,
                                                           AmazonClientException

Used to request the settings for an app.

Specified by:

getApplicationSettings in interface AmazonPinpoint

Parameters:

getApplicationSettingsRequest -

Returns:

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

Throws:

BadRequestException - 400 response

InternalServerErrorException - 500 response

ForbiddenException - 403 response

NotFoundException - 404 response

MethodNotAllowedException - 405 response

TooManyRequestsException - 429 response

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

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

getCampaign

public GetCampaignResult getCampaign(GetCampaignRequest getCampaignRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

Returns information about a campaign.

Specified by:

getCampaign in interface AmazonPinpoint

Parameters:

getCampaignRequest -

Returns:

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

Throws:

BadRequestException - 400 response

InternalServerErrorException - 500 response

ForbiddenException - 403 response

NotFoundException - 404 response

MethodNotAllowedException - 405 response

TooManyRequestsException - 429 response

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

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

getCampaignActivities

public GetCampaignActivitiesResult getCampaignActivities(GetCampaignActivitiesRequest getCampaignActivitiesRequest)
                                                  throws AmazonServiceException,
                                                         AmazonClientException

Returns information about the activity performed by a campaign.

Specified by:

getCampaignActivities in interface AmazonPinpoint

Parameters:

getCampaignActivitiesRequest -

Returns:

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

Throws:

BadRequestException - 400 response

InternalServerErrorException - 500 response

ForbiddenException - 403 response

NotFoundException - 404 response

MethodNotAllowedException - 405 response

TooManyRequestsException - 429 response

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

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

getCampaignVersion

public GetCampaignVersionResult getCampaignVersion(GetCampaignVersionRequest getCampaignVersionRequest)
                                            throws AmazonServiceException,
                                                   AmazonClientException

Returns information about your campaign versions.

Specified by:

getCampaignVersion in interface AmazonPinpoint

Parameters:

getCampaignVersionRequest -

Returns:

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

Throws:

BadRequestException - 400 response

InternalServerErrorException - 500 response

ForbiddenException - 403 response

NotFoundException - 404 response

MethodNotAllowedException - 405 response

TooManyRequestsException - 429 response

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

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

getCampaignVersions

public GetCampaignVersionsResult getCampaignVersions(GetCampaignVersionsRequest getCampaignVersionsRequest)
                                              throws AmazonServiceException,
                                                     AmazonClientException

Returns information about your campaign versions.

Specified by:

getCampaignVersions in interface AmazonPinpoint

Parameters:

getCampaignVersionsRequest -

Returns:

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

Throws:

BadRequestException - 400 response

InternalServerErrorException - 500 response

ForbiddenException - 403 response

NotFoundException - 404 response

MethodNotAllowedException - 405 response

TooManyRequestsException - 429 response

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

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

getCampaigns

public GetCampaignsResult getCampaigns(GetCampaignsRequest getCampaignsRequest)
                                throws AmazonServiceException,
                                       AmazonClientException

Returns information about your campaigns.

Specified by:

getCampaigns in interface AmazonPinpoint

Parameters:

getCampaignsRequest -

Returns:

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

Throws:

BadRequestException - 400 response

InternalServerErrorException - 500 response

ForbiddenException - 403 response

NotFoundException - 404 response

MethodNotAllowedException - 405 response

TooManyRequestsException - 429 response

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

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

getEndpoint

public GetEndpointResult getEndpoint(GetEndpointRequest getEndpointRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

Returns information about an endpoint.

Specified by:

getEndpoint in interface AmazonPinpoint

Parameters:

getEndpointRequest -

Returns:

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

Throws:

BadRequestException - 400 response

InternalServerErrorException - 500 response

ForbiddenException - 403 response

NotFoundException - 404 response

MethodNotAllowedException - 405 response

TooManyRequestsException - 429 response

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

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

getGcmChannel

public GetGcmChannelResult getGcmChannel(GetGcmChannelRequest getGcmChannelRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

Returns information about the GCM channel for an app.

Specified by:

getGcmChannel in interface AmazonPinpoint

Parameters:

getGcmChannelRequest -

Returns:

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

Throws:

BadRequestException - 400 response

InternalServerErrorException - 500 response

ForbiddenException - 403 response

NotFoundException - 404 response

MethodNotAllowedException - 405 response

TooManyRequestsException - 429 response

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

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

getImportJob

public GetImportJobResult getImportJob(GetImportJobRequest getImportJobRequest)
                                throws AmazonServiceException,
                                       AmazonClientException

Returns information about an import job.

Specified by:

getImportJob in interface AmazonPinpoint

Parameters:

getImportJobRequest -

Returns:

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

Throws:

BadRequestException - 400 response

InternalServerErrorException - 500 response

ForbiddenException - 403 response

NotFoundException - 404 response

MethodNotAllowedException - 405 response

TooManyRequestsException - 429 response

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

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

getImportJobs

public GetImportJobsResult getImportJobs(GetImportJobsRequest getImportJobsRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

Returns information about your import jobs.

Specified by:

getImportJobs in interface AmazonPinpoint

Parameters:

getImportJobsRequest -

Returns:

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

Throws:

BadRequestException - 400 response

InternalServerErrorException - 500 response

ForbiddenException - 403 response

NotFoundException - 404 response

MethodNotAllowedException - 405 response

TooManyRequestsException - 429 response

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

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

getSegment

public GetSegmentResult getSegment(GetSegmentRequest getSegmentRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

Returns information about a segment.

Specified by:

getSegment in interface AmazonPinpoint

Parameters:

getSegmentRequest -

Returns:

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

Throws:

BadRequestException - 400 response

InternalServerErrorException - 500 response

ForbiddenException - 403 response

NotFoundException - 404 response

MethodNotAllowedException - 405 response

TooManyRequestsException - 429 response

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

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

getSegmentImportJobs

public GetSegmentImportJobsResult getSegmentImportJobs(GetSegmentImportJobsRequest getSegmentImportJobsRequest)
                                                throws AmazonServiceException,
                                                       AmazonClientException

Returns a list of import jobs for a specific segment.

Specified by:

getSegmentImportJobs in interface AmazonPinpoint

Parameters:

getSegmentImportJobsRequest -

Returns:

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

Throws:

BadRequestException - 400 response

InternalServerErrorException - 500 response

ForbiddenException - 403 response

NotFoundException - 404 response

MethodNotAllowedException - 405 response

TooManyRequestsException - 429 response

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

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

getSegmentVersion

public GetSegmentVersionResult getSegmentVersion(GetSegmentVersionRequest getSegmentVersionRequest)
                                          throws AmazonServiceException,
                                                 AmazonClientException

Returns information about a segment version.

Specified by:

getSegmentVersion in interface AmazonPinpoint

Parameters:

getSegmentVersionRequest -

Returns:

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

Throws:

BadRequestException - 400 response

InternalServerErrorException - 500 response

ForbiddenException - 403 response

NotFoundException - 404 response

MethodNotAllowedException - 405 response

TooManyRequestsException - 429 response

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

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

getSegmentVersions

public GetSegmentVersionsResult getSegmentVersions(GetSegmentVersionsRequest getSegmentVersionsRequest)
                                            throws AmazonServiceException,
                                                   AmazonClientException

Returns information about your segment versions.

Specified by:

getSegmentVersions in interface AmazonPinpoint

Parameters:

getSegmentVersionsRequest -

Returns:

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

Throws:

BadRequestException - 400 response

InternalServerErrorException - 500 response

ForbiddenException - 403 response

NotFoundException - 404 response

MethodNotAllowedException - 405 response

TooManyRequestsException - 429 response

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

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

getSegments

public GetSegmentsResult getSegments(GetSegmentsRequest getSegmentsRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

Used to get information about your segments.

Specified by:

getSegments in interface AmazonPinpoint

Parameters:

getSegmentsRequest -

Returns:

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

Throws:

BadRequestException - 400 response

InternalServerErrorException - 500 response

ForbiddenException - 403 response

NotFoundException - 404 response

MethodNotAllowedException - 405 response

TooManyRequestsException - 429 response

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

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

updateApnsChannel

public UpdateApnsChannelResult updateApnsChannel(UpdateApnsChannelRequest updateApnsChannelRequest)
                                          throws AmazonServiceException,
                                                 AmazonClientException

Use to update the APNs channel for an app.

Specified by:

updateApnsChannel in interface AmazonPinpoint

Parameters:

updateApnsChannelRequest -

Returns:

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

Throws:

BadRequestException - 400 response

InternalServerErrorException - 500 response

ForbiddenException - 403 response

NotFoundException - 404 response

MethodNotAllowedException - 405 response

TooManyRequestsException - 429 response

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

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

updateApplicationSettings

public UpdateApplicationSettingsResult updateApplicationSettings(UpdateApplicationSettingsRequest updateApplicationSettingsRequest)
                                                          throws AmazonServiceException,
                                                                 AmazonClientException

Used to update the settings for an app.

Specified by:

updateApplicationSettings in interface AmazonPinpoint

Parameters:

updateApplicationSettingsRequest -

Returns:

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

Throws:

BadRequestException - 400 response

InternalServerErrorException - 500 response

ForbiddenException - 403 response

NotFoundException - 404 response

MethodNotAllowedException - 405 response

TooManyRequestsException - 429 response

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

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

updateCampaign

public UpdateCampaignResult updateCampaign(UpdateCampaignRequest updateCampaignRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

Use to update a campaign.

Specified by:

updateCampaign in interface AmazonPinpoint

Parameters:

updateCampaignRequest -

Returns:

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

Throws:

BadRequestException - 400 response

InternalServerErrorException - 500 response

ForbiddenException - 403 response

NotFoundException - 404 response

MethodNotAllowedException - 405 response

TooManyRequestsException - 429 response

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

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

updateEndpoint

public UpdateEndpointResult updateEndpoint(UpdateEndpointRequest updateEndpointRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

Use to update an endpoint.

Specified by:

updateEndpoint in interface AmazonPinpoint

Parameters:

updateEndpointRequest -

Returns:

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

Throws:

BadRequestException - 400 response

InternalServerErrorException - 500 response

ForbiddenException - 403 response

NotFoundException - 404 response

MethodNotAllowedException - 405 response

TooManyRequestsException - 429 response

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

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

updateEndpointsBatch

public UpdateEndpointsBatchResult updateEndpointsBatch(UpdateEndpointsBatchRequest updateEndpointsBatchRequest)
                                                throws AmazonServiceException,
                                                       AmazonClientException

Use to update your endpoints.

Specified by:

updateEndpointsBatch in interface AmazonPinpoint

Parameters:

updateEndpointsBatchRequest -

Returns:

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

Throws:

BadRequestException - 400 response

InternalServerErrorException - 500 response

ForbiddenException - 403 response

NotFoundException - 404 response

MethodNotAllowedException - 405 response

TooManyRequestsException - 429 response

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

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

updateGcmChannel

public UpdateGcmChannelResult updateGcmChannel(UpdateGcmChannelRequest updateGcmChannelRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

Use to update the GCM channel for an app.

Specified by:

updateGcmChannel in interface AmazonPinpoint

Parameters:

updateGcmChannelRequest -

Returns:

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

Throws:

BadRequestException - 400 response

InternalServerErrorException - 500 response

ForbiddenException - 403 response

NotFoundException - 404 response

MethodNotAllowedException - 405 response

TooManyRequestsException - 429 response

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

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

updateSegment

public UpdateSegmentResult updateSegment(UpdateSegmentRequest updateSegmentRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

Use to update a segment.

Specified by:

updateSegment in interface AmazonPinpoint

Parameters:

updateSegmentRequest -

Returns:

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

Throws:

BadRequestException - 400 response

InternalServerErrorException - 500 response

ForbiddenException - 403 response

NotFoundException - 404 response

MethodNotAllowedException - 405 response

TooManyRequestsException - 429 response

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

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

getCachedResponseMetadata

@Deprecated
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Deprecated. ResponseMetadata cache can hold up to 50 requests and responses in memory and will cause memory issue. This method now always returns null.

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 the request.

Specified by:

getCachedResponseMetadata in interface AmazonPinpoint

Parameters:

request - The originally executed request

Returns:

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