AmazonPinpointClient (AWS Java SDK for Amazon Pinpoint 1.11.481 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.pinpoint.AmazonPinpointClient

All Implemented Interfaces:

AmazonPinpoint

Direct Known Subclasses:

AmazonPinpointAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonPinpointClient
extends AmazonWebServiceClient
implements AmazonPinpoint
```
Client for accessing Amazon Pinpoint. All service calls made using this client are blocking, and will not return until the service call completes.
Amazon Pinpoint

Field Summary

Fields
Modifier and Type Field and Description

protected static ClientConfigurationFactory configFactory
Client configuration factory providing ClientConfigurations tailored to this client
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
- Fields inherited from interface com.amazonaws.services.pinpoint.AmazonPinpoint
  ENDPOINT_PREFIX

Fields
Modifier and Type	Field and Description
`protected static ClientConfigurationFactory`	`configFactory` Client configuration factory providing ClientConfigurations tailored to this client

Constructor Summary

Constructors
Constructor and Description
`AmazonPinpointClient()` Deprecated. use `AmazonPinpointClientBuilder.defaultClient()`
`AmazonPinpointClient(AWSCredentials awsCredentials)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)` for example: `AmazonPinpointClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();`
`AmazonPinpointClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)` and `AwsClientBuilder.withClientConfiguration(ClientConfiguration)`
`AmazonPinpointClient(AWSCredentialsProvider awsCredentialsProvider)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)`
`AmazonPinpointClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)` and `AwsClientBuilder.withClientConfiguration(ClientConfiguration)`
`AmazonPinpointClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)` and `AwsClientBuilder.withClientConfiguration(ClientConfiguration)` and `AwsClientBuilder.withMetricsCollector(RequestMetricCollector)`
`AmazonPinpointClient(ClientConfiguration clientConfiguration)` Deprecated. use `AwsClientBuilder.withClientConfiguration(ClientConfiguration)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static AmazonPinpointClientBuilder`	`builder()`
`CreateAppResult`	`createApp(CreateAppRequest request)` Creates or updates an app.
`CreateCampaignResult`	`createCampaign(CreateCampaignRequest request)` Creates or updates a campaign.
`CreateExportJobResult`	`createExportJob(CreateExportJobRequest request)` Creates an export job.
`CreateImportJobResult`	`createImportJob(CreateImportJobRequest request)` Creates or updates an import job.
`CreateSegmentResult`	`createSegment(CreateSegmentRequest request)` Used to create or update a segment.
`DeleteAdmChannelResult`	`deleteAdmChannel(DeleteAdmChannelRequest request)` Delete an ADM channel.
`DeleteApnsChannelResult`	`deleteApnsChannel(DeleteApnsChannelRequest request)` Deletes the APNs channel for an app.
`DeleteApnsSandboxChannelResult`	`deleteApnsSandboxChannel(DeleteApnsSandboxChannelRequest request)` Delete an APNS sandbox channel.
`DeleteApnsVoipChannelResult`	`deleteApnsVoipChannel(DeleteApnsVoipChannelRequest request)` Delete an APNS VoIP channel
`DeleteApnsVoipSandboxChannelResult`	`deleteApnsVoipSandboxChannel(DeleteApnsVoipSandboxChannelRequest request)` Delete an APNS VoIP sandbox channel
`DeleteAppResult`	`deleteApp(DeleteAppRequest request)` Deletes an app.
`DeleteBaiduChannelResult`	`deleteBaiduChannel(DeleteBaiduChannelRequest request)` Delete a BAIDU GCM channel
`DeleteCampaignResult`	`deleteCampaign(DeleteCampaignRequest request)` Deletes a campaign.
`DeleteEmailChannelResult`	`deleteEmailChannel(DeleteEmailChannelRequest request)` Delete an email channel.
`DeleteEndpointResult`	`deleteEndpoint(DeleteEndpointRequest request)` Deletes an endpoint.
`DeleteEventStreamResult`	`deleteEventStream(DeleteEventStreamRequest request)` Deletes the event stream for an app.
`DeleteGcmChannelResult`	`deleteGcmChannel(DeleteGcmChannelRequest request)` Deletes the GCM channel for an app.
`DeleteSegmentResult`	`deleteSegment(DeleteSegmentRequest request)` Deletes a segment.
`DeleteSmsChannelResult`	`deleteSmsChannel(DeleteSmsChannelRequest request)` Delete an SMS channel.
`DeleteUserEndpointsResult`	`deleteUserEndpoints(DeleteUserEndpointsRequest request)` Deletes endpoints that are associated with a User ID.
`DeleteVoiceChannelResult`	`deleteVoiceChannel(DeleteVoiceChannelRequest request)` Delete an Voice channel
`GetAdmChannelResult`	`getAdmChannel(GetAdmChannelRequest request)` Get an ADM channel.
`GetApnsChannelResult`	`getApnsChannel(GetApnsChannelRequest request)` Returns information about the APNs channel for an app.
`GetApnsSandboxChannelResult`	`getApnsSandboxChannel(GetApnsSandboxChannelRequest request)` Get an APNS sandbox channel.
`GetApnsVoipChannelResult`	`getApnsVoipChannel(GetApnsVoipChannelRequest request)` Get an APNS VoIP channel
`GetApnsVoipSandboxChannelResult`	`getApnsVoipSandboxChannel(GetApnsVoipSandboxChannelRequest request)` Get an APNS VoIPSandbox channel
`GetAppResult`	`getApp(GetAppRequest request)` Returns information about an app.
`GetApplicationSettingsResult`	`getApplicationSettings(GetApplicationSettingsRequest request)` Used to request the settings for an app.
`GetAppsResult`	`getApps(GetAppsRequest request)` Returns information about your apps.
`GetBaiduChannelResult`	`getBaiduChannel(GetBaiduChannelRequest request)` Get a BAIDU GCM channel
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
`GetCampaignResult`	`getCampaign(GetCampaignRequest request)` Returns information about a campaign.
`GetCampaignActivitiesResult`	`getCampaignActivities(GetCampaignActivitiesRequest request)` Returns information about the activity performed by a campaign.
`GetCampaignsResult`	`getCampaigns(GetCampaignsRequest request)` Returns information about your campaigns.
`GetCampaignVersionResult`	`getCampaignVersion(GetCampaignVersionRequest request)` Returns information about a specific version of a campaign.
`GetCampaignVersionsResult`	`getCampaignVersions(GetCampaignVersionsRequest request)` Returns information about your campaign versions.
`GetChannelsResult`	`getChannels(GetChannelsRequest request)` Get all channels.
`GetEmailChannelResult`	`getEmailChannel(GetEmailChannelRequest request)` Get an email channel.
`GetEndpointResult`	`getEndpoint(GetEndpointRequest request)` Returns information about an endpoint.
`GetEventStreamResult`	`getEventStream(GetEventStreamRequest request)` Returns the event stream for an app.
`GetExportJobResult`	`getExportJob(GetExportJobRequest request)` Returns information about an export job.
`GetExportJobsResult`	`getExportJobs(GetExportJobsRequest request)` Returns information about your export jobs.
`GetGcmChannelResult`	`getGcmChannel(GetGcmChannelRequest request)` Returns information about the GCM channel for an app.
`GetImportJobResult`	`getImportJob(GetImportJobRequest request)` Returns information about an import job.
`GetImportJobsResult`	`getImportJobs(GetImportJobsRequest request)` Returns information about your import jobs.
`GetSegmentResult`	`getSegment(GetSegmentRequest request)` Returns information about a segment.
`GetSegmentExportJobsResult`	`getSegmentExportJobs(GetSegmentExportJobsRequest request)` Returns a list of export jobs for a specific segment.
`GetSegmentImportJobsResult`	`getSegmentImportJobs(GetSegmentImportJobsRequest request)` Returns a list of import jobs for a specific segment.
`GetSegmentsResult`	`getSegments(GetSegmentsRequest request)` Used to get information about your segments.
`GetSegmentVersionResult`	`getSegmentVersion(GetSegmentVersionRequest request)` Returns information about a segment version.
`GetSegmentVersionsResult`	`getSegmentVersions(GetSegmentVersionsRequest request)` Returns information about your segment versions.
`GetSmsChannelResult`	`getSmsChannel(GetSmsChannelRequest request)` Get an SMS channel.
`GetUserEndpointsResult`	`getUserEndpoints(GetUserEndpointsRequest request)` Returns information about the endpoints that are associated with a User ID.
`GetVoiceChannelResult`	`getVoiceChannel(GetVoiceChannelRequest request)` Get a Voice Channel
`PhoneNumberValidateResult`	`phoneNumberValidate(PhoneNumberValidateRequest request)` Returns information about the specified phone number.
`PutEventsResult`	`putEvents(PutEventsRequest request)` Use to record events for endpoints.
`PutEventStreamResult`	`putEventStream(PutEventStreamRequest request)` Use to create or update the event stream for an app.
`RemoveAttributesResult`	`removeAttributes(RemoveAttributesRequest request)` Used to remove the attributes for an app
`SendMessagesResult`	`sendMessages(SendMessagesRequest request)` Used to send a direct message.
`SendUsersMessagesResult`	`sendUsersMessages(SendUsersMessagesRequest request)` Used to send a message to a list of users.
`UpdateAdmChannelResult`	`updateAdmChannel(UpdateAdmChannelRequest request)` Update an ADM channel.
`UpdateApnsChannelResult`	`updateApnsChannel(UpdateApnsChannelRequest request)` Use to update the APNs channel for an app.
`UpdateApnsSandboxChannelResult`	`updateApnsSandboxChannel(UpdateApnsSandboxChannelRequest request)` Update an APNS sandbox channel.
`UpdateApnsVoipChannelResult`	`updateApnsVoipChannel(UpdateApnsVoipChannelRequest request)` Update an APNS VoIP channel
`UpdateApnsVoipSandboxChannelResult`	`updateApnsVoipSandboxChannel(UpdateApnsVoipSandboxChannelRequest request)` Update an APNS VoIP sandbox channel
`UpdateApplicationSettingsResult`	`updateApplicationSettings(UpdateApplicationSettingsRequest request)` Used to update the settings for an app.
`UpdateBaiduChannelResult`	`updateBaiduChannel(UpdateBaiduChannelRequest request)` Update a BAIDU GCM channel
`UpdateCampaignResult`	`updateCampaign(UpdateCampaignRequest request)` Use to update a campaign.
`UpdateEmailChannelResult`	`updateEmailChannel(UpdateEmailChannelRequest request)` Update an email channel.
`UpdateEndpointResult`	`updateEndpoint(UpdateEndpointRequest request)` Creates or updates an endpoint.
`UpdateEndpointsBatchResult`	`updateEndpointsBatch(UpdateEndpointsBatchRequest request)` Use to update a batch of endpoints.
`UpdateGcmChannelResult`	`updateGcmChannel(UpdateGcmChannelRequest request)` Use to update the GCM channel for an app.
`UpdateSegmentResult`	`updateSegment(UpdateSegmentRequest request)` Used to update a segment.
`UpdateSmsChannelResult`	`updateSmsChannel(UpdateSmsChannelRequest request)` Update an SMS channel.
`UpdateVoiceChannelResult`	`updateVoiceChannel(UpdateVoiceChannelRequest request)` Update an Voice channel

Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, shutdown, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, 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
  - configFactory
```
protected static final ClientConfigurationFactory configFactory
```
    Client configuration factory providing ClientConfigurations tailored to this client
- Constructor Detail
  - AmazonPinpointClient
```
@Deprecated
public AmazonPinpointClient()
```
    Deprecated. use AmazonPinpointClientBuilder.defaultClient()
    Constructs a new client to invoke service methods on Amazon Pinpoint. 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. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)
    Constructs a new client to invoke service methods on Amazon Pinpoint. 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 Amazon Pinpoint (ex: proxy settings, retry counts, etc.).
    
    See Also:
    
    DefaultAWSCredentialsProviderChain
  - AmazonPinpointClient
```
@Deprecated
public AmazonPinpointClient(AWSCredentials awsCredentials)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AmazonPinpointClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
    
    Constructs a new client to invoke service methods on Amazon Pinpoint using the specified AWS account credentials.
    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
```
@Deprecated
public AmazonPinpointClient(AWSCredentials awsCredentials,
                                        ClientConfiguration clientConfiguration)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
    
    Constructs a new client to invoke service methods on Amazon Pinpoint using the specified AWS account credentials and client configuration options.
    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 Amazon Pinpoint (ex: proxy settings, retry counts, etc.).
  - AmazonPinpointClient
```
@Deprecated
public AmazonPinpointClient(AWSCredentialsProvider awsCredentialsProvider)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)
    
    Constructs a new client to invoke service methods on Amazon Pinpoint using the specified AWS account credentials provider.
    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
```
@Deprecated
public AmazonPinpointClient(AWSCredentialsProvider awsCredentialsProvider,
                                        ClientConfiguration clientConfiguration)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
    
    Constructs a new client to invoke service methods on Amazon Pinpoint using the specified AWS account credentials provider and client configuration options.
    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 Amazon Pinpoint (ex: proxy settings, retry counts, etc.).
  - AmazonPinpointClient
```
@Deprecated
public AmazonPinpointClient(AWSCredentialsProvider awsCredentialsProvider,
                                        ClientConfiguration clientConfiguration,
                                        RequestMetricCollector requestMetricCollector)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
    
    Constructs a new client to invoke service methods on Amazon Pinpoint 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 Amazon Pinpoint (ex: proxy settings, retry counts, etc.).
    
    requestMetricCollector - optional request metric collector
- Method Detail
  - builder
```
public static AmazonPinpointClientBuilder builder()
```
  - createApp
```
public CreateAppResult createApp(CreateAppRequest request)
```
    Creates or updates an app.
    
    Specified by:
    
    createApp in interface AmazonPinpoint
    
    Parameters:
    
    createAppRequest -
    
    Returns:
    
    Result of the CreateApp operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - createCampaign
```
public CreateCampaignResult createCampaign(CreateCampaignRequest request)
```
    Creates or updates a campaign.
    
    Specified by:
    
    createCampaign in interface AmazonPinpoint
    
    Parameters:
    
    createCampaignRequest -
    
    Returns:
    
    Result of the CreateCampaign operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - createExportJob
```
public CreateExportJobResult createExportJob(CreateExportJobRequest request)
```
    Creates an export job.
    
    Specified by:
    
    createExportJob in interface AmazonPinpoint
    
    Parameters:
    
    createExportJobRequest -
    
    Returns:
    
    Result of the CreateExportJob operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - createImportJob
```
public CreateImportJobResult createImportJob(CreateImportJobRequest request)
```
    Creates or updates an import job.
    
    Specified by:
    
    createImportJob in interface AmazonPinpoint
    
    Parameters:
    
    createImportJobRequest -
    
    Returns:
    
    Result of the CreateImportJob operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - createSegment
```
public CreateSegmentResult createSegment(CreateSegmentRequest request)
```
    Used to create or update a segment.
    
    Specified by:
    
    createSegment in interface AmazonPinpoint
    
    Parameters:
    
    createSegmentRequest -
    
    Returns:
    
    Result of the CreateSegment operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - deleteAdmChannel
```
public DeleteAdmChannelResult deleteAdmChannel(DeleteAdmChannelRequest request)
```
    Delete an ADM channel.
    
    Specified by:
    
    deleteAdmChannel in interface AmazonPinpoint
    
    Parameters:
    
    deleteAdmChannelRequest -
    
    Returns:
    
    Result of the DeleteAdmChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - deleteApnsChannel
```
public DeleteApnsChannelResult deleteApnsChannel(DeleteApnsChannelRequest request)
```
    Deletes the APNs channel for an app.
    
    Specified by:
    
    deleteApnsChannel in interface AmazonPinpoint
    
    Parameters:
    
    deleteApnsChannelRequest -
    
    Returns:
    
    Result of the DeleteApnsChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - deleteApnsSandboxChannel
```
public DeleteApnsSandboxChannelResult deleteApnsSandboxChannel(DeleteApnsSandboxChannelRequest request)
```
    Delete an APNS sandbox channel.
    
    Specified by:
    
    deleteApnsSandboxChannel in interface AmazonPinpoint
    
    Parameters:
    
    deleteApnsSandboxChannelRequest -
    
    Returns:
    
    Result of the DeleteApnsSandboxChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - deleteApnsVoipChannel
```
public DeleteApnsVoipChannelResult deleteApnsVoipChannel(DeleteApnsVoipChannelRequest request)
```
    Delete an APNS VoIP channel
    
    Specified by:
    
    deleteApnsVoipChannel in interface AmazonPinpoint
    
    Parameters:
    
    deleteApnsVoipChannelRequest -
    
    Returns:
    
    Result of the DeleteApnsVoipChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - deleteApnsVoipSandboxChannel
```
public DeleteApnsVoipSandboxChannelResult deleteApnsVoipSandboxChannel(DeleteApnsVoipSandboxChannelRequest request)
```
    Delete an APNS VoIP sandbox channel
    
    Specified by:
    
    deleteApnsVoipSandboxChannel in interface AmazonPinpoint
    
    Parameters:
    
    deleteApnsVoipSandboxChannelRequest -
    
    Returns:
    
    Result of the DeleteApnsVoipSandboxChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - deleteApp
```
public DeleteAppResult deleteApp(DeleteAppRequest request)
```
    Deletes an app.
    
    Specified by:
    
    deleteApp in interface AmazonPinpoint
    
    Parameters:
    
    deleteAppRequest -
    
    Returns:
    
    Result of the DeleteApp operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - deleteBaiduChannel
```
public DeleteBaiduChannelResult deleteBaiduChannel(DeleteBaiduChannelRequest request)
```
    Delete a BAIDU GCM channel
    
    Specified by:
    
    deleteBaiduChannel in interface AmazonPinpoint
    
    Parameters:
    
    deleteBaiduChannelRequest -
    
    Returns:
    
    Result of the DeleteBaiduChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - deleteCampaign
```
public DeleteCampaignResult deleteCampaign(DeleteCampaignRequest request)
```
    Deletes a campaign.
    
    Specified by:
    
    deleteCampaign in interface AmazonPinpoint
    
    Parameters:
    
    deleteCampaignRequest -
    
    Returns:
    
    Result of the DeleteCampaign operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - deleteEmailChannel
```
public DeleteEmailChannelResult deleteEmailChannel(DeleteEmailChannelRequest request)
```
    Delete an email channel.
    
    Specified by:
    
    deleteEmailChannel in interface AmazonPinpoint
    
    Parameters:
    
    deleteEmailChannelRequest -
    
    Returns:
    
    Result of the DeleteEmailChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - deleteEndpoint
```
public DeleteEndpointResult deleteEndpoint(DeleteEndpointRequest request)
```
    Deletes an endpoint.
    
    Specified by:
    
    deleteEndpoint in interface AmazonPinpoint
    
    Parameters:
    
    deleteEndpointRequest -
    
    Returns:
    
    Result of the DeleteEndpoint operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - deleteEventStream
```
public DeleteEventStreamResult deleteEventStream(DeleteEventStreamRequest request)
```
    Deletes the event stream for an app.
    
    Specified by:
    
    deleteEventStream in interface AmazonPinpoint
    
    Parameters:
    
    deleteEventStreamRequest -
    
    Returns:
    
    Result of the DeleteEventStream operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - deleteGcmChannel
```
public DeleteGcmChannelResult deleteGcmChannel(DeleteGcmChannelRequest request)
```
    Deletes the GCM channel for an app.
    
    Specified by:
    
    deleteGcmChannel in interface AmazonPinpoint
    
    Parameters:
    
    deleteGcmChannelRequest -
    
    Returns:
    
    Result of the DeleteGcmChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - deleteSegment
```
public DeleteSegmentResult deleteSegment(DeleteSegmentRequest request)
```
    Deletes a segment.
    
    Specified by:
    
    deleteSegment in interface AmazonPinpoint
    
    Parameters:
    
    deleteSegmentRequest -
    
    Returns:
    
    Result of the DeleteSegment operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - deleteSmsChannel
```
public DeleteSmsChannelResult deleteSmsChannel(DeleteSmsChannelRequest request)
```
    Delete an SMS channel.
    
    Specified by:
    
    deleteSmsChannel in interface AmazonPinpoint
    
    Parameters:
    
    deleteSmsChannelRequest -
    
    Returns:
    
    Result of the DeleteSmsChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - deleteUserEndpoints
```
public DeleteUserEndpointsResult deleteUserEndpoints(DeleteUserEndpointsRequest request)
```
    Deletes endpoints that are associated with a User ID.
    
    Specified by:
    
    deleteUserEndpoints in interface AmazonPinpoint
    
    Parameters:
    
    deleteUserEndpointsRequest -
    
    Returns:
    
    Result of the DeleteUserEndpoints operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - deleteVoiceChannel
```
public DeleteVoiceChannelResult deleteVoiceChannel(DeleteVoiceChannelRequest request)
```
    Delete an Voice channel
    
    Specified by:
    
    deleteVoiceChannel in interface AmazonPinpoint
    
    Parameters:
    
    deleteVoiceChannelRequest -
    
    Returns:
    
    Result of the DeleteVoiceChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - getAdmChannel
```
public GetAdmChannelResult getAdmChannel(GetAdmChannelRequest request)
```
    Get an ADM channel.
    
    Specified by:
    
    getAdmChannel in interface AmazonPinpoint
    
    Parameters:
    
    getAdmChannelRequest -
    
    Returns:
    
    Result of the GetAdmChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - getApnsChannel
```
public GetApnsChannelResult getApnsChannel(GetApnsChannelRequest request)
```
    Returns information about the APNs channel for an app.
    
    Specified by:
    
    getApnsChannel in interface AmazonPinpoint
    
    Parameters:
    
    getApnsChannelRequest -
    
    Returns:
    
    Result of the GetApnsChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - getApnsSandboxChannel
```
public GetApnsSandboxChannelResult getApnsSandboxChannel(GetApnsSandboxChannelRequest request)
```
    Get an APNS sandbox channel.
    
    Specified by:
    
    getApnsSandboxChannel in interface AmazonPinpoint
    
    Parameters:
    
    getApnsSandboxChannelRequest -
    
    Returns:
    
    Result of the GetApnsSandboxChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - getApnsVoipChannel
```
public GetApnsVoipChannelResult getApnsVoipChannel(GetApnsVoipChannelRequest request)
```
    Get an APNS VoIP channel
    
    Specified by:
    
    getApnsVoipChannel in interface AmazonPinpoint
    
    Parameters:
    
    getApnsVoipChannelRequest -
    
    Returns:
    
    Result of the GetApnsVoipChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - getApnsVoipSandboxChannel
```
public GetApnsVoipSandboxChannelResult getApnsVoipSandboxChannel(GetApnsVoipSandboxChannelRequest request)
```
    Get an APNS VoIPSandbox channel
    
    Specified by:
    
    getApnsVoipSandboxChannel in interface AmazonPinpoint
    
    Parameters:
    
    getApnsVoipSandboxChannelRequest -
    
    Returns:
    
    Result of the GetApnsVoipSandboxChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - getApp
```
public GetAppResult getApp(GetAppRequest request)
```
    Returns information about an app.
    
    Specified by:
    
    getApp in interface AmazonPinpoint
    
    Parameters:
    
    getAppRequest -
    
    Returns:
    
    Result of the GetApp operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - getApplicationSettings
```
public GetApplicationSettingsResult getApplicationSettings(GetApplicationSettingsRequest request)
```
    Used to request the settings for an app.
    
    Specified by:
    
    getApplicationSettings in interface AmazonPinpoint
    
    Parameters:
    
    getApplicationSettingsRequest -
    
    Returns:
    
    Result of the GetApplicationSettings operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - getApps
```
public GetAppsResult getApps(GetAppsRequest request)
```
    Returns information about your apps.
    
    Specified by:
    
    getApps in interface AmazonPinpoint
    
    Parameters:
    
    getAppsRequest -
    
    Returns:
    
    Result of the GetApps operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - getBaiduChannel
```
public GetBaiduChannelResult getBaiduChannel(GetBaiduChannelRequest request)
```
    Get a BAIDU GCM channel
    
    Specified by:
    
    getBaiduChannel in interface AmazonPinpoint
    
    Parameters:
    
    getBaiduChannelRequest -
    
    Returns:
    
    Result of the GetBaiduChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - getCampaign
```
public GetCampaignResult getCampaign(GetCampaignRequest request)
```
    Returns information about a campaign.
    
    Specified by:
    
    getCampaign in interface AmazonPinpoint
    
    Parameters:
    
    getCampaignRequest -
    
    Returns:
    
    Result of the GetCampaign operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - getCampaignActivities
```
public GetCampaignActivitiesResult getCampaignActivities(GetCampaignActivitiesRequest request)
```
    Returns information about the activity performed by a campaign.
    
    Specified by:
    
    getCampaignActivities in interface AmazonPinpoint
    
    Parameters:
    
    getCampaignActivitiesRequest -
    
    Returns:
    
    Result of the GetCampaignActivities operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - getCampaignVersion
```
public GetCampaignVersionResult getCampaignVersion(GetCampaignVersionRequest request)
```
    Returns information about a specific version of a campaign.
    
    Specified by:
    
    getCampaignVersion in interface AmazonPinpoint
    
    Parameters:
    
    getCampaignVersionRequest -
    
    Returns:
    
    Result of the GetCampaignVersion operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - getCampaignVersions
```
public GetCampaignVersionsResult getCampaignVersions(GetCampaignVersionsRequest request)
```
    Returns information about your campaign versions.
    
    Specified by:
    
    getCampaignVersions in interface AmazonPinpoint
    
    Parameters:
    
    getCampaignVersionsRequest -
    
    Returns:
    
    Result of the GetCampaignVersions operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - getCampaigns
```
public GetCampaignsResult getCampaigns(GetCampaignsRequest request)
```
    Returns information about your campaigns.
    
    Specified by:
    
    getCampaigns in interface AmazonPinpoint
    
    Parameters:
    
    getCampaignsRequest -
    
    Returns:
    
    Result of the GetCampaigns operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - getChannels
```
public GetChannelsResult getChannels(GetChannelsRequest request)
```
    Get all channels.
    
    Specified by:
    
    getChannels in interface AmazonPinpoint
    
    Parameters:
    
    getChannelsRequest -
    
    Returns:
    
    Result of the GetChannels operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - getEmailChannel
```
public GetEmailChannelResult getEmailChannel(GetEmailChannelRequest request)
```
    Get an email channel.
    
    Specified by:
    
    getEmailChannel in interface AmazonPinpoint
    
    Parameters:
    
    getEmailChannelRequest -
    
    Returns:
    
    Result of the GetEmailChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - getEndpoint
```
public GetEndpointResult getEndpoint(GetEndpointRequest request)
```
    Returns information about an endpoint.
    
    Specified by:
    
    getEndpoint in interface AmazonPinpoint
    
    Parameters:
    
    getEndpointRequest -
    
    Returns:
    
    Result of the GetEndpoint operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - getEventStream
```
public GetEventStreamResult getEventStream(GetEventStreamRequest request)
```
    Returns the event stream for an app.
    
    Specified by:
    
    getEventStream in interface AmazonPinpoint
    
    Parameters:
    
    getEventStreamRequest -
    
    Returns:
    
    Result of the GetEventStream operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - getExportJob
```
public GetExportJobResult getExportJob(GetExportJobRequest request)
```
    Returns information about an export job.
    
    Specified by:
    
    getExportJob in interface AmazonPinpoint
    
    Parameters:
    
    getExportJobRequest -
    
    Returns:
    
    Result of the GetExportJob operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - getExportJobs
```
public GetExportJobsResult getExportJobs(GetExportJobsRequest request)
```
    Returns information about your export jobs.
    
    Specified by:
    
    getExportJobs in interface AmazonPinpoint
    
    Parameters:
    
    getExportJobsRequest -
    
    Returns:
    
    Result of the GetExportJobs operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - getGcmChannel
```
public GetGcmChannelResult getGcmChannel(GetGcmChannelRequest request)
```
    Returns information about the GCM channel for an app.
    
    Specified by:
    
    getGcmChannel in interface AmazonPinpoint
    
    Parameters:
    
    getGcmChannelRequest -
    
    Returns:
    
    Result of the GetGcmChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - getImportJob
```
public GetImportJobResult getImportJob(GetImportJobRequest request)
```
    Returns information about an import job.
    
    Specified by:
    
    getImportJob in interface AmazonPinpoint
    
    Parameters:
    
    getImportJobRequest -
    
    Returns:
    
    Result of the GetImportJob operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - getImportJobs
```
public GetImportJobsResult getImportJobs(GetImportJobsRequest request)
```
    Returns information about your import jobs.
    
    Specified by:
    
    getImportJobs in interface AmazonPinpoint
    
    Parameters:
    
    getImportJobsRequest -
    
    Returns:
    
    Result of the GetImportJobs operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - getSegment
```
public GetSegmentResult getSegment(GetSegmentRequest request)
```
    Returns information about a segment.
    
    Specified by:
    
    getSegment in interface AmazonPinpoint
    
    Parameters:
    
    getSegmentRequest -
    
    Returns:
    
    Result of the GetSegment operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - getSegmentExportJobs
```
public GetSegmentExportJobsResult getSegmentExportJobs(GetSegmentExportJobsRequest request)
```
    Returns a list of export jobs for a specific segment.
    
    Specified by:
    
    getSegmentExportJobs in interface AmazonPinpoint
    
    Parameters:
    
    getSegmentExportJobsRequest -
    
    Returns:
    
    Result of the GetSegmentExportJobs operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - getSegmentImportJobs
```
public GetSegmentImportJobsResult getSegmentImportJobs(GetSegmentImportJobsRequest request)
```
    Returns a list of import jobs for a specific segment.
    
    Specified by:
    
    getSegmentImportJobs in interface AmazonPinpoint
    
    Parameters:
    
    getSegmentImportJobsRequest -
    
    Returns:
    
    Result of the GetSegmentImportJobs operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - getSegmentVersion
```
public GetSegmentVersionResult getSegmentVersion(GetSegmentVersionRequest request)
```
    Returns information about a segment version.
    
    Specified by:
    
    getSegmentVersion in interface AmazonPinpoint
    
    Parameters:
    
    getSegmentVersionRequest -
    
    Returns:
    
    Result of the GetSegmentVersion operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - getSegmentVersions
```
public GetSegmentVersionsResult getSegmentVersions(GetSegmentVersionsRequest request)
```
    Returns information about your segment versions.
    
    Specified by:
    
    getSegmentVersions in interface AmazonPinpoint
    
    Parameters:
    
    getSegmentVersionsRequest -
    
    Returns:
    
    Result of the GetSegmentVersions operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - getSegments
```
public GetSegmentsResult getSegments(GetSegmentsRequest request)
```
    Used to get information about your segments.
    
    Specified by:
    
    getSegments in interface AmazonPinpoint
    
    Parameters:
    
    getSegmentsRequest -
    
    Returns:
    
    Result of the GetSegments operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - getSmsChannel
```
public GetSmsChannelResult getSmsChannel(GetSmsChannelRequest request)
```
    Get an SMS channel.
    
    Specified by:
    
    getSmsChannel in interface AmazonPinpoint
    
    Parameters:
    
    getSmsChannelRequest -
    
    Returns:
    
    Result of the GetSmsChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - getUserEndpoints
```
public GetUserEndpointsResult getUserEndpoints(GetUserEndpointsRequest request)
```
    Returns information about the endpoints that are associated with a User ID.
    
    Specified by:
    
    getUserEndpoints in interface AmazonPinpoint
    
    Parameters:
    
    getUserEndpointsRequest -
    
    Returns:
    
    Result of the GetUserEndpoints operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - getVoiceChannel
```
public GetVoiceChannelResult getVoiceChannel(GetVoiceChannelRequest request)
```
    Get a Voice Channel
    
    Specified by:
    
    getVoiceChannel in interface AmazonPinpoint
    
    Parameters:
    
    getVoiceChannelRequest -
    
    Returns:
    
    Result of the GetVoiceChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - phoneNumberValidate
```
public PhoneNumberValidateResult phoneNumberValidate(PhoneNumberValidateRequest request)
```
    Returns information about the specified phone number.
    
    Specified by:
    
    phoneNumberValidate in interface AmazonPinpoint
    
    Parameters:
    
    phoneNumberValidateRequest -
    
    Returns:
    
    Result of the PhoneNumberValidate operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - putEventStream
```
public PutEventStreamResult putEventStream(PutEventStreamRequest request)
```
    Use to create or update the event stream for an app.
    
    Specified by:
    
    putEventStream in interface AmazonPinpoint
    
    Parameters:
    
    putEventStreamRequest -
    
    Returns:
    
    Result of the PutEventStream operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - putEvents
```
public PutEventsResult putEvents(PutEventsRequest request)
```
    Use to record events for endpoints. This method creates events and creates or updates the endpoints that those events are associated with.
    
    Specified by:
    
    putEvents in interface AmazonPinpoint
    
    Parameters:
    
    putEventsRequest -
    
    Returns:
    
    Result of the PutEvents operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - removeAttributes
```
public RemoveAttributesResult removeAttributes(RemoveAttributesRequest request)
```
    Used to remove the attributes for an app
    
    Specified by:
    
    removeAttributes in interface AmazonPinpoint
    
    Parameters:
    
    removeAttributesRequest -
    
    Returns:
    
    Result of the RemoveAttributes operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - sendMessages
```
public SendMessagesResult sendMessages(SendMessagesRequest request)
```
    Used to send a direct message.
    
    Specified by:
    
    sendMessages in interface AmazonPinpoint
    
    Parameters:
    
    sendMessagesRequest -
    
    Returns:
    
    Result of the SendMessages operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - sendUsersMessages
```
public SendUsersMessagesResult sendUsersMessages(SendUsersMessagesRequest request)
```
    Used to send a message to a list of users.
    
    Specified by:
    
    sendUsersMessages in interface AmazonPinpoint
    
    Parameters:
    
    sendUsersMessagesRequest -
    
    Returns:
    
    Result of the SendUsersMessages operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - updateAdmChannel
```
public UpdateAdmChannelResult updateAdmChannel(UpdateAdmChannelRequest request)
```
    Update an ADM channel.
    
    Specified by:
    
    updateAdmChannel in interface AmazonPinpoint
    
    Parameters:
    
    updateAdmChannelRequest -
    
    Returns:
    
    Result of the UpdateAdmChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - updateApnsChannel
```
public UpdateApnsChannelResult updateApnsChannel(UpdateApnsChannelRequest request)
```
    Use to update the APNs channel for an app.
    
    Specified by:
    
    updateApnsChannel in interface AmazonPinpoint
    
    Parameters:
    
    updateApnsChannelRequest -
    
    Returns:
    
    Result of the UpdateApnsChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - updateApnsSandboxChannel
```
public UpdateApnsSandboxChannelResult updateApnsSandboxChannel(UpdateApnsSandboxChannelRequest request)
```
    Update an APNS sandbox channel.
    
    Specified by:
    
    updateApnsSandboxChannel in interface AmazonPinpoint
    
    Parameters:
    
    updateApnsSandboxChannelRequest -
    
    Returns:
    
    Result of the UpdateApnsSandboxChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - updateApnsVoipChannel
```
public UpdateApnsVoipChannelResult updateApnsVoipChannel(UpdateApnsVoipChannelRequest request)
```
    Update an APNS VoIP channel
    
    Specified by:
    
    updateApnsVoipChannel in interface AmazonPinpoint
    
    Parameters:
    
    updateApnsVoipChannelRequest -
    
    Returns:
    
    Result of the UpdateApnsVoipChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - updateApnsVoipSandboxChannel
```
public UpdateApnsVoipSandboxChannelResult updateApnsVoipSandboxChannel(UpdateApnsVoipSandboxChannelRequest request)
```
    Update an APNS VoIP sandbox channel
    
    Specified by:
    
    updateApnsVoipSandboxChannel in interface AmazonPinpoint
    
    Parameters:
    
    updateApnsVoipSandboxChannelRequest -
    
    Returns:
    
    Result of the UpdateApnsVoipSandboxChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - updateApplicationSettings
```
public UpdateApplicationSettingsResult updateApplicationSettings(UpdateApplicationSettingsRequest request)
```
    Used to update the settings for an app.
    
    Specified by:
    
    updateApplicationSettings in interface AmazonPinpoint
    
    Parameters:
    
    updateApplicationSettingsRequest -
    
    Returns:
    
    Result of the UpdateApplicationSettings operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - updateBaiduChannel
```
public UpdateBaiduChannelResult updateBaiduChannel(UpdateBaiduChannelRequest request)
```
    Update a BAIDU GCM channel
    
    Specified by:
    
    updateBaiduChannel in interface AmazonPinpoint
    
    Parameters:
    
    updateBaiduChannelRequest -
    
    Returns:
    
    Result of the UpdateBaiduChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - updateCampaign
```
public UpdateCampaignResult updateCampaign(UpdateCampaignRequest request)
```
    Use to update a campaign.
    
    Specified by:
    
    updateCampaign in interface AmazonPinpoint
    
    Parameters:
    
    updateCampaignRequest -
    
    Returns:
    
    Result of the UpdateCampaign operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - updateEmailChannel
```
public UpdateEmailChannelResult updateEmailChannel(UpdateEmailChannelRequest request)
```
    Update an email channel.
    
    Specified by:
    
    updateEmailChannel in interface AmazonPinpoint
    
    Parameters:
    
    updateEmailChannelRequest -
    
    Returns:
    
    Result of the UpdateEmailChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - updateEndpoint
```
public UpdateEndpointResult updateEndpoint(UpdateEndpointRequest request)
```
    Creates or updates an endpoint.
    
    Specified by:
    
    updateEndpoint in interface AmazonPinpoint
    
    Parameters:
    
    updateEndpointRequest -
    
    Returns:
    
    Result of the UpdateEndpoint operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - updateEndpointsBatch
```
public UpdateEndpointsBatchResult updateEndpointsBatch(UpdateEndpointsBatchRequest request)
```
    Use to update a batch of endpoints.
    
    Specified by:
    
    updateEndpointsBatch in interface AmazonPinpoint
    
    Parameters:
    
    updateEndpointsBatchRequest -
    
    Returns:
    
    Result of the UpdateEndpointsBatch operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - updateGcmChannel
```
public UpdateGcmChannelResult updateGcmChannel(UpdateGcmChannelRequest request)
```
    Use to update the GCM channel for an app.
    
    Specified by:
    
    updateGcmChannel in interface AmazonPinpoint
    
    Parameters:
    
    updateGcmChannelRequest -
    
    Returns:
    
    Result of the UpdateGcmChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - updateSegment
```
public UpdateSegmentResult updateSegment(UpdateSegmentRequest request)
```
    Used to update a segment.
    
    Specified by:
    
    updateSegment in interface AmazonPinpoint
    
    Parameters:
    
    updateSegmentRequest -
    
    Returns:
    
    Result of the UpdateSegment operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - updateSmsChannel
```
public UpdateSmsChannelResult updateSmsChannel(UpdateSmsChannelRequest request)
```
    Update an SMS channel.
    
    Specified by:
    
    updateSmsChannel in interface AmazonPinpoint
    
    Parameters:
    
    updateSmsChannelRequest -
    
    Returns:
    
    Result of the UpdateSmsChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - updateVoiceChannel
```
public UpdateVoiceChannelResult updateVoiceChannel(UpdateVoiceChannelRequest request)
```
    Update an Voice channel
    
    Specified by:
    
    updateVoiceChannel in interface AmazonPinpoint
    
    Parameters:
    
    updateVoiceChannelRequest -
    
    Returns:
    
    Result of the UpdateVoiceChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing 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.

Class AmazonPinpointClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

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

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

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

Field Detail

configFactory

Constructor Detail

AmazonPinpointClient

AmazonPinpointClient

AmazonPinpointClient

AmazonPinpointClient

AmazonPinpointClient

AmazonPinpointClient

AmazonPinpointClient

Method Detail

builder

createApp

createCampaign

createExportJob

createImportJob

createSegment

deleteAdmChannel

deleteApnsChannel

deleteApnsSandboxChannel

deleteApnsVoipChannel

deleteApnsVoipSandboxChannel

deleteApp

deleteBaiduChannel

deleteCampaign

deleteEmailChannel

deleteEndpoint

deleteEventStream

deleteGcmChannel

deleteSegment

deleteSmsChannel

deleteUserEndpoints

deleteVoiceChannel

getAdmChannel

getApnsChannel

getApnsSandboxChannel

getApnsVoipChannel

getApnsVoipSandboxChannel

getApp

getApplicationSettings

getApps

getBaiduChannel

getCampaign

getCampaignActivities

getCampaignVersion

getCampaignVersions

getCampaigns

getChannels

getEmailChannel

getEndpoint

getEventStream

getExportJob

getExportJobs

getGcmChannel

getImportJob

getImportJobs

getSegment

getSegmentExportJobs

getSegmentImportJobs

getSegmentVersion

getSegmentVersions

getSegments

getSmsChannel

getUserEndpoints

getVoiceChannel

phoneNumberValidate

putEventStream

putEvents

removeAttributes

sendMessages

sendUsersMessages