AmazonPinpointClient (AWS Java SDK for Amazon Pinpoint 1.11.163 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.

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()`
`CreateCampaignResult`	`createCampaign(CreateCampaignRequest request)` Creates or updates a campaign.
`CreateImportJobResult`	`createImportJob(CreateImportJobRequest request)` Creates or updates an import job.
`CreateSegmentResult`	`createSegment(CreateSegmentRequest request)` Used to create or update a segment.
`DeleteApnsChannelResult`	`deleteApnsChannel(DeleteApnsChannelRequest request)` Deletes the APNs channel for an app.
`DeleteApnsSandboxChannelResult`	`deleteApnsSandboxChannel(DeleteApnsSandboxChannelRequest request)` Delete an APNS sandbox channel
`DeleteCampaignResult`	`deleteCampaign(DeleteCampaignRequest request)` Deletes a campaign.
`DeleteEmailChannelResult`	`deleteEmailChannel(DeleteEmailChannelRequest request)` Delete an email channel
`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
`GetApnsChannelResult`	`getApnsChannel(GetApnsChannelRequest request)` Returns information about the APNs channel for an app.
`GetApnsSandboxChannelResult`	`getApnsSandboxChannel(GetApnsSandboxChannelRequest request)` Get an APNS sandbox channel
`GetApplicationSettingsResult`	`getApplicationSettings(GetApplicationSettingsRequest request)` Used to request the settings for an app.
`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.
`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.
`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.
`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
`PutEventStreamResult`	`putEventStream(PutEventStreamRequest request)` Use to create or update the event stream for an app.
`SendMessagesResult`	`sendMessages(SendMessagesRequest request)` Send a batch of messages
`UpdateApnsChannelResult`	`updateApnsChannel(UpdateApnsChannelRequest request)` Use to update the APNs channel for an app.
`UpdateApnsSandboxChannelResult`	`updateApnsSandboxChannel(UpdateApnsSandboxChannelRequest request)` Update an APNS sandbox channel
`UpdateApplicationSettingsResult`	`updateApplicationSettings(UpdateApplicationSettingsRequest request)` Used to update the settings for an app.
`UpdateCampaignResult`	`updateCampaign(UpdateCampaignRequest request)` Use to update a campaign.
`UpdateEmailChannelResult`	`updateEmailChannel(UpdateEmailChannelRequest request)` Update an email channel
`UpdateEndpointResult`	`updateEndpoint(UpdateEndpointRequest request)` Use to update 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)` Use to update a segment.
`UpdateSmsChannelResult`	`updateSmsChannel(UpdateSmsChannelRequest request)` Update an SMS channel

Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, 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()
```
  - 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 - Simple message object.
    
    InternalServerErrorException - Simple message object.
    
    ForbiddenException - Simple message object.
    
    NotFoundException - Simple message object.
    
    MethodNotAllowedException - Simple message object.
    
    TooManyRequestsException - Simple message object.
  - 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 - Simple message object.
    
    InternalServerErrorException - Simple message object.
    
    ForbiddenException - Simple message object.
    
    NotFoundException - Simple message object.
    
    MethodNotAllowedException - Simple message object.
    
    TooManyRequestsException - Simple message object.
  - 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 - Simple message object.
    
    InternalServerErrorException - Simple message object.
    
    ForbiddenException - Simple message object.
    
    NotFoundException - Simple message object.
    
    MethodNotAllowedException - Simple message object.
    
    TooManyRequestsException - Simple message object.
  - 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 - Simple message object.
    
    InternalServerErrorException - Simple message object.
    
    ForbiddenException - Simple message object.
    
    NotFoundException - Simple message object.
    
    MethodNotAllowedException - Simple message object.
    
    TooManyRequestsException - Simple message object.
  - 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 - Simple message object.
    
    InternalServerErrorException - Simple message object.
    
    ForbiddenException - Simple message object.
    
    NotFoundException - Simple message object.
    
    MethodNotAllowedException - Simple message object.
    
    TooManyRequestsException - Simple message object.
  - 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 - Simple message object.
    
    InternalServerErrorException - Simple message object.
    
    ForbiddenException - Simple message object.
    
    NotFoundException - Simple message object.
    
    MethodNotAllowedException - Simple message object.
    
    TooManyRequestsException - Simple message object.
  - 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 - Simple message object.
    
    InternalServerErrorException - Simple message object.
    
    ForbiddenException - Simple message object.
    
    NotFoundException - Simple message object.
    
    MethodNotAllowedException - Simple message object.
    
    TooManyRequestsException - Simple message object.
  - deleteEventStream
```
public DeleteEventStreamResult deleteEventStream(DeleteEventStreamRequest request)
```
    Deletes the event stream for an app.
    
    Specified by:
    
    deleteEventStream in interface AmazonPinpoint
    
    Parameters:
    
    deleteEventStreamRequest - DeleteEventStream Request
    
    Returns:
    
    Result of the DeleteEventStream operation returned by the service.
    
    Throws:
    
    BadRequestException - Simple message object.
    
    InternalServerErrorException - Simple message object.
    
    ForbiddenException - Simple message object.
    
    NotFoundException - Simple message object.
    
    MethodNotAllowedException - Simple message object.
    
    TooManyRequestsException - Simple message object.
  - 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 - Simple message object.
    
    InternalServerErrorException - Simple message object.
    
    ForbiddenException - Simple message object.
    
    NotFoundException - Simple message object.
    
    MethodNotAllowedException - Simple message object.
    
    TooManyRequestsException - Simple message object.
  - 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 - Simple message object.
    
    InternalServerErrorException - Simple message object.
    
    ForbiddenException - Simple message object.
    
    NotFoundException - Simple message object.
    
    MethodNotAllowedException - Simple message object.
    
    TooManyRequestsException - Simple message object.
  - 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 - Simple message object.
    
    InternalServerErrorException - Simple message object.
    
    ForbiddenException - Simple message object.
    
    NotFoundException - Simple message object.
    
    MethodNotAllowedException - Simple message object.
    
    TooManyRequestsException - Simple message object.
  - 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 - Simple message object.
    
    InternalServerErrorException - Simple message object.
    
    ForbiddenException - Simple message object.
    
    NotFoundException - Simple message object.
    
    MethodNotAllowedException - Simple message object.
    
    TooManyRequestsException - Simple message object.
  - 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 - Simple message object.
    
    InternalServerErrorException - Simple message object.
    
    ForbiddenException - Simple message object.
    
    NotFoundException - Simple message object.
    
    MethodNotAllowedException - Simple message object.
    
    TooManyRequestsException - Simple message object.
  - 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 - Simple message object.
    
    InternalServerErrorException - Simple message object.
    
    ForbiddenException - Simple message object.
    
    NotFoundException - Simple message object.
    
    MethodNotAllowedException - Simple message object.
    
    TooManyRequestsException - Simple message object.
  - 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 - Simple message object.
    
    InternalServerErrorException - Simple message object.
    
    ForbiddenException - Simple message object.
    
    NotFoundException - Simple message object.
    
    MethodNotAllowedException - Simple message object.
    
    TooManyRequestsException - Simple message object.
  - 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 - Simple message object.
    
    InternalServerErrorException - Simple message object.
    
    ForbiddenException - Simple message object.
    
    NotFoundException - Simple message object.
    
    MethodNotAllowedException - Simple message object.
    
    TooManyRequestsException - Simple message object.
  - 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 - Simple message object.
    
    InternalServerErrorException - Simple message object.
    
    ForbiddenException - Simple message object.
    
    NotFoundException - Simple message object.
    
    MethodNotAllowedException - Simple message object.
    
    TooManyRequestsException - Simple message object.
  - 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 - Simple message object.
    
    InternalServerErrorException - Simple message object.
    
    ForbiddenException - Simple message object.
    
    NotFoundException - Simple message object.
    
    MethodNotAllowedException - Simple message object.
    
    TooManyRequestsException - Simple message object.
  - 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 - Simple message object.
    
    InternalServerErrorException - Simple message object.
    
    ForbiddenException - Simple message object.
    
    NotFoundException - Simple message object.
    
    MethodNotAllowedException - Simple message object.
    
    TooManyRequestsException - Simple message object.
  - 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 - Simple message object.
    
    InternalServerErrorException - Simple message object.
    
    ForbiddenException - Simple message object.
    
    NotFoundException - Simple message object.
    
    MethodNotAllowedException - Simple message object.
    
    TooManyRequestsException - Simple message object.
  - 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 - Simple message object.
    
    InternalServerErrorException - Simple message object.
    
    ForbiddenException - Simple message object.
    
    NotFoundException - Simple message object.
    
    MethodNotAllowedException - Simple message object.
    
    TooManyRequestsException - Simple message object.
  - getEventStream
```
public GetEventStreamResult getEventStream(GetEventStreamRequest request)
```
    Returns the event stream for an app.
    
    Specified by:
    
    getEventStream in interface AmazonPinpoint
    
    Parameters:
    
    getEventStreamRequest - GetEventStream Request
    
    Returns:
    
    Result of the GetEventStream operation returned by the service.
    
    Throws:
    
    BadRequestException - Simple message object.
    
    InternalServerErrorException - Simple message object.
    
    ForbiddenException - Simple message object.
    
    NotFoundException - Simple message object.
    
    MethodNotAllowedException - Simple message object.
    
    TooManyRequestsException - Simple message object.
  - 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 - Simple message object.
    
    InternalServerErrorException - Simple message object.
    
    ForbiddenException - Simple message object.
    
    NotFoundException - Simple message object.
    
    MethodNotAllowedException - Simple message object.
    
    TooManyRequestsException - Simple message object.
  - 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 - Simple message object.
    
    InternalServerErrorException - Simple message object.
    
    ForbiddenException - Simple message object.
    
    NotFoundException - Simple message object.
    
    MethodNotAllowedException - Simple message object.
    
    TooManyRequestsException - Simple message object.
  - 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 - Simple message object.
    
    InternalServerErrorException - Simple message object.
    
    ForbiddenException - Simple message object.
    
    NotFoundException - Simple message object.
    
    MethodNotAllowedException - Simple message object.
    
    TooManyRequestsException - Simple message object.
  - 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 - Simple message object.
    
    InternalServerErrorException - Simple message object.
    
    ForbiddenException - Simple message object.
    
    NotFoundException - Simple message object.
    
    MethodNotAllowedException - Simple message object.
    
    TooManyRequestsException - Simple message object.
  - 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 - Simple message object.
    
    InternalServerErrorException - Simple message object.
    
    ForbiddenException - Simple message object.
    
    NotFoundException - Simple message object.
    
    MethodNotAllowedException - Simple message object.
    
    TooManyRequestsException - Simple message object.
  - 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 - Simple message object.
    
    InternalServerErrorException - Simple message object.
    
    ForbiddenException - Simple message object.
    
    NotFoundException - Simple message object.
    
    MethodNotAllowedException - Simple message object.
    
    TooManyRequestsException - Simple message object.
  - 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 - Simple message object.
    
    InternalServerErrorException - Simple message object.
    
    ForbiddenException - Simple message object.
    
    NotFoundException - Simple message object.
    
    MethodNotAllowedException - Simple message object.
    
    TooManyRequestsException - Simple message object.
  - 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 - Simple message object.
    
    InternalServerErrorException - Simple message object.
    
    ForbiddenException - Simple message object.
    
    NotFoundException - Simple message object.
    
    MethodNotAllowedException - Simple message object.
    
    TooManyRequestsException - Simple message object.
  - 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 - Simple message object.
    
    InternalServerErrorException - Simple message object.
    
    ForbiddenException - Simple message object.
    
    NotFoundException - Simple message object.
    
    MethodNotAllowedException - Simple message object.
    
    TooManyRequestsException - Simple message object.
  - 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 - PutEventStream Request
    
    Returns:
    
    Result of the PutEventStream operation returned by the service.
    
    Throws:
    
    BadRequestException - Simple message object.
    
    InternalServerErrorException - Simple message object.
    
    ForbiddenException - Simple message object.
    
    NotFoundException - Simple message object.
    
    MethodNotAllowedException - Simple message object.
    
    TooManyRequestsException - Simple message object.
  - sendMessages
```
public SendMessagesResult sendMessages(SendMessagesRequest request)
```
    Send a batch of messages
    
    Specified by:
    
    sendMessages in interface AmazonPinpoint
    
    Parameters:
    
    sendMessagesRequest -
    
    Returns:
    
    Result of the SendMessages operation returned by the service.
    
    Throws:
    
    BadRequestException - Simple message object.
    
    InternalServerErrorException - Simple message object.
    
    ForbiddenException - Simple message object.
    
    NotFoundException - Simple message object.
    
    MethodNotAllowedException - Simple message object.
    
    TooManyRequestsException - Simple message object.
  - 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 - Simple message object.
    
    InternalServerErrorException - Simple message object.
    
    ForbiddenException - Simple message object.
    
    NotFoundException - Simple message object.
    
    MethodNotAllowedException - Simple message object.
    
    TooManyRequestsException - Simple message object.
  - 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 - Simple message object.
    
    InternalServerErrorException - Simple message object.
    
    ForbiddenException - Simple message object.
    
    NotFoundException - Simple message object.
    
    MethodNotAllowedException - Simple message object.
    
    TooManyRequestsException - Simple message object.
  - 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 - Simple message object.
    
    InternalServerErrorException - Simple message object.
    
    ForbiddenException - Simple message object.
    
    NotFoundException - Simple message object.
    
    MethodNotAllowedException - Simple message object.
    
    TooManyRequestsException - Simple message object.
  - 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 - Simple message object.
    
    InternalServerErrorException - Simple message object.
    
    ForbiddenException - Simple message object.
    
    NotFoundException - Simple message object.
    
    MethodNotAllowedException - Simple message object.
    
    TooManyRequestsException - Simple message object.
  - 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 - Simple message object.
    
    InternalServerErrorException - Simple message object.
    
    ForbiddenException - Simple message object.
    
    NotFoundException - Simple message object.
    
    MethodNotAllowedException - Simple message object.
    
    TooManyRequestsException - Simple message object.
  - updateEndpoint
```
public UpdateEndpointResult updateEndpoint(UpdateEndpointRequest request)
```
    Use to update an endpoint.
    
    Specified by:
    
    updateEndpoint in interface AmazonPinpoint
    
    Parameters:
    
    updateEndpointRequest -
    
    Returns:
    
    Result of the UpdateEndpoint operation returned by the service.
    
    Throws:
    
    BadRequestException - Simple message object.
    
    InternalServerErrorException - Simple message object.
    
    ForbiddenException - Simple message object.
    
    NotFoundException - Simple message object.
    
    MethodNotAllowedException - Simple message object.
    
    TooManyRequestsException - Simple message object.
  - 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 - Simple message object.
    
    InternalServerErrorException - Simple message object.
    
    ForbiddenException - Simple message object.
    
    NotFoundException - Simple message object.
    
    MethodNotAllowedException - Simple message object.
    
    TooManyRequestsException - Simple message object.
  - 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 - Simple message object.
    
    InternalServerErrorException - Simple message object.
    
    ForbiddenException - Simple message object.
    
    NotFoundException - Simple message object.
    
    MethodNotAllowedException - Simple message object.
    
    TooManyRequestsException - Simple message object.
  - updateSegment
```
public UpdateSegmentResult updateSegment(UpdateSegmentRequest request)
```
    Use to update a segment.
    
    Specified by:
    
    updateSegment in interface AmazonPinpoint
    
    Parameters:
    
    updateSegmentRequest -
    
    Returns:
    
    Result of the UpdateSegment operation returned by the service.
    
    Throws:
    
    BadRequestException - Simple message object.
    
    InternalServerErrorException - Simple message object.
    
    ForbiddenException - Simple message object.
    
    NotFoundException - Simple message object.
    
    MethodNotAllowedException - Simple message object.
    
    TooManyRequestsException - Simple message object.
  - 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 - Simple message object.
    
    InternalServerErrorException - Simple message object.
    
    ForbiddenException - Simple message object.
    
    NotFoundException - Simple message object.
    
    MethodNotAllowedException - Simple message object.
    
    TooManyRequestsException - Simple message object.
  - 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

createCampaign

createImportJob

createSegment

deleteApnsChannel

deleteApnsSandboxChannel

deleteCampaign

deleteEmailChannel

deleteEventStream

deleteGcmChannel

deleteSegment

deleteSmsChannel

getApnsChannel

getApnsSandboxChannel

getApplicationSettings

getCampaign

getCampaignActivities

getCampaignVersion

getCampaignVersions

getCampaigns

getEmailChannel

getEndpoint

getEventStream

getGcmChannel

getImportJob

getImportJobs

getSegment

getSegmentImportJobs

getSegmentVersion

getSegmentVersions

getSegments

getSmsChannel

putEventStream

sendMessages

updateApnsChannel

updateApnsSandboxChannel

updateApplicationSettings

updateCampaign

updateEmailChannel

updateEndpoint

updateEndpointsBatch

updateGcmChannel

updateSegment

updateSmsChannel

getCachedResponseMetadata