AbstractAmazonPinpoint (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.pinpoint.AbstractAmazonPinpoint

All Implemented Interfaces:

AmazonPinpoint

Direct Known Subclasses:

AbstractAmazonPinpointAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonPinpoint
extends Object
implements AmazonPinpoint
```
Abstract implementation of AmazonPinpoint. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.pinpoint.AmazonPinpoint
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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.
`DeleteCampaignResult`	`deleteCampaign(DeleteCampaignRequest request)` Deletes a campaign.
`DeleteGcmChannelResult`	`deleteGcmChannel(DeleteGcmChannelRequest request)` Deletes the GCM channel for an app.
`DeleteSegmentResult`	`deleteSegment(DeleteSegmentRequest request)` Deletes a segment.
`GetApnsChannelResult`	`getApnsChannel(GetApnsChannelRequest request)` Returns information about the APNs channel for an app.
`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 your campaign versions.
`GetCampaignVersionsResult`	`getCampaignVersions(GetCampaignVersionsRequest request)` Returns information about your campaign versions.
`GetEndpointResult`	`getEndpoint(GetEndpointRequest request)` Returns information about an endpoint.
`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.
`void`	`setEndpoint(String endpoint)` Overrides the default endpoint for this client ("https://pinpoint.us-east-1.amazonaws.com").
`void`	`setRegion(Region region)` An alternative to `AmazonPinpoint.setEndpoint(String)`, sets the regional endpoint for this client's service calls.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`UpdateApnsChannelResult`	`updateApnsChannel(UpdateApnsChannelRequest request)` Use to update the APNs channel for an app.
`UpdateApplicationSettingsResult`	`updateApplicationSettings(UpdateApplicationSettingsRequest request)` Used to update the settings for an app.
`UpdateCampaignResult`	`updateCampaign(UpdateCampaignRequest request)` Use to update a campaign.
`UpdateEndpointResult`	`updateEndpoint(UpdateEndpointRequest request)` Use to update an endpoint.
`UpdateEndpointsBatchResult`	`updateEndpointsBatch(UpdateEndpointsBatchRequest request)` Use to update your endpoints.
`UpdateGcmChannelResult`	`updateGcmChannel(UpdateGcmChannelRequest request)` Use to update the GCM channel for an app.
`UpdateSegmentResult`	`updateSegment(UpdateSegmentRequest request)` Use to update a segment.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: AmazonPinpoint
    
    Overrides the default endpoint for this client ("https://pinpoint.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.
    Callers can pass in just the endpoint (ex: "pinpoint.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://pinpoint.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.
    For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
    This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Specified by:
    
    setEndpoint in interface AmazonPinpoint
    
    Parameters:
    
    endpoint - The endpoint (ex: "pinpoint.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://pinpoint.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: AmazonPinpoint
    
    An alternative to AmazonPinpoint.setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.
    By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.
    This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Specified by:
    
    setRegion in interface AmazonPinpoint
    
    Parameters:
    
    region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.
    
    See Also:
    
    Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)
  - createCampaign
```
public CreateCampaignResult createCampaign(CreateCampaignRequest request)
```
    Description copied from interface: AmazonPinpoint
    
    Creates or updates a campaign.
    
    Specified by:
    
    createCampaign in interface AmazonPinpoint
    
    Returns:
    
    Result of the CreateCampaign operation returned by the service.
  - createImportJob
```
public CreateImportJobResult createImportJob(CreateImportJobRequest request)
```
    Description copied from interface: AmazonPinpoint
    
    Creates or updates an import job.
    
    Specified by:
    
    createImportJob in interface AmazonPinpoint
    
    Returns:
    
    Result of the CreateImportJob operation returned by the service.
  - createSegment
```
public CreateSegmentResult createSegment(CreateSegmentRequest request)
```
    Description copied from interface: AmazonPinpoint
    
    Used to create or update a segment.
    
    Specified by:
    
    createSegment in interface AmazonPinpoint
    
    Returns:
    
    Result of the CreateSegment operation returned by the service.
  - deleteApnsChannel
```
public DeleteApnsChannelResult deleteApnsChannel(DeleteApnsChannelRequest request)
```
    Description copied from interface: AmazonPinpoint
    
    Deletes the APNs channel for an app.
    
    Specified by:
    
    deleteApnsChannel in interface AmazonPinpoint
    
    Returns:
    
    Result of the DeleteApnsChannel operation returned by the service.
  - deleteCampaign
```
public DeleteCampaignResult deleteCampaign(DeleteCampaignRequest request)
```
    Description copied from interface: AmazonPinpoint
    
    Deletes a campaign.
    
    Specified by:
    
    deleteCampaign in interface AmazonPinpoint
    
    Returns:
    
    Result of the DeleteCampaign operation returned by the service.
  - deleteGcmChannel
```
public DeleteGcmChannelResult deleteGcmChannel(DeleteGcmChannelRequest request)
```
    Description copied from interface: AmazonPinpoint
    
    Deletes the GCM channel for an app.
    
    Specified by:
    
    deleteGcmChannel in interface AmazonPinpoint
    
    Returns:
    
    Result of the DeleteGcmChannel operation returned by the service.
  - deleteSegment
```
public DeleteSegmentResult deleteSegment(DeleteSegmentRequest request)
```
    Description copied from interface: AmazonPinpoint
    
    Deletes a segment.
    
    Specified by:
    
    deleteSegment in interface AmazonPinpoint
    
    Returns:
    
    Result of the DeleteSegment operation returned by the service.
  - getApnsChannel
```
public GetApnsChannelResult getApnsChannel(GetApnsChannelRequest request)
```
    Description copied from interface: AmazonPinpoint
    
    Returns information about the APNs channel for an app.
    
    Specified by:
    
    getApnsChannel in interface AmazonPinpoint
    
    Returns:
    
    Result of the GetApnsChannel operation returned by the service.
  - getApplicationSettings
```
public GetApplicationSettingsResult getApplicationSettings(GetApplicationSettingsRequest request)
```
    Description copied from interface: AmazonPinpoint
    
    Used to request the settings for an app.
    
    Specified by:
    
    getApplicationSettings in interface AmazonPinpoint
    
    Returns:
    
    Result of the GetApplicationSettings operation returned by the service.
  - getCampaign
```
public GetCampaignResult getCampaign(GetCampaignRequest request)
```
    Description copied from interface: AmazonPinpoint
    
    Returns information about a campaign.
    
    Specified by:
    
    getCampaign in interface AmazonPinpoint
    
    Returns:
    
    Result of the GetCampaign operation returned by the service.
  - getCampaignActivities
```
public GetCampaignActivitiesResult getCampaignActivities(GetCampaignActivitiesRequest request)
```
    Description copied from interface: AmazonPinpoint
    
    Returns information about the activity performed by a campaign.
    
    Specified by:
    
    getCampaignActivities in interface AmazonPinpoint
    
    Returns:
    
    Result of the GetCampaignActivities operation returned by the service.
  - getCampaignVersion
```
public GetCampaignVersionResult getCampaignVersion(GetCampaignVersionRequest request)
```
    Description copied from interface: AmazonPinpoint
    
    Returns information about your campaign versions.
    
    Specified by:
    
    getCampaignVersion in interface AmazonPinpoint
    
    Returns:
    
    Result of the GetCampaignVersion operation returned by the service.
  - getCampaignVersions
```
public GetCampaignVersionsResult getCampaignVersions(GetCampaignVersionsRequest request)
```
    Description copied from interface: AmazonPinpoint
    
    Returns information about your campaign versions.
    
    Specified by:
    
    getCampaignVersions in interface AmazonPinpoint
    
    Returns:
    
    Result of the GetCampaignVersions operation returned by the service.
  - getCampaigns
```
public GetCampaignsResult getCampaigns(GetCampaignsRequest request)
```
    Description copied from interface: AmazonPinpoint
    
    Returns information about your campaigns.
    
    Specified by:
    
    getCampaigns in interface AmazonPinpoint
    
    Returns:
    
    Result of the GetCampaigns operation returned by the service.
  - getEndpoint
```
public GetEndpointResult getEndpoint(GetEndpointRequest request)
```
    Description copied from interface: AmazonPinpoint
    
    Returns information about an endpoint.
    
    Specified by:
    
    getEndpoint in interface AmazonPinpoint
    
    Returns:
    
    Result of the GetEndpoint operation returned by the service.
  - getGcmChannel
```
public GetGcmChannelResult getGcmChannel(GetGcmChannelRequest request)
```
    Description copied from interface: AmazonPinpoint
    
    Returns information about the GCM channel for an app.
    
    Specified by:
    
    getGcmChannel in interface AmazonPinpoint
    
    Returns:
    
    Result of the GetGcmChannel operation returned by the service.
  - getImportJob
```
public GetImportJobResult getImportJob(GetImportJobRequest request)
```
    Description copied from interface: AmazonPinpoint
    
    Returns information about an import job.
    
    Specified by:
    
    getImportJob in interface AmazonPinpoint
    
    Returns:
    
    Result of the GetImportJob operation returned by the service.
  - getImportJobs
```
public GetImportJobsResult getImportJobs(GetImportJobsRequest request)
```
    Description copied from interface: AmazonPinpoint
    
    Returns information about your import jobs.
    
    Specified by:
    
    getImportJobs in interface AmazonPinpoint
    
    Returns:
    
    Result of the GetImportJobs operation returned by the service.
  - getSegment
```
public GetSegmentResult getSegment(GetSegmentRequest request)
```
    Description copied from interface: AmazonPinpoint
    
    Returns information about a segment.
    
    Specified by:
    
    getSegment in interface AmazonPinpoint
    
    Returns:
    
    Result of the GetSegment operation returned by the service.
  - getSegmentImportJobs
```
public GetSegmentImportJobsResult getSegmentImportJobs(GetSegmentImportJobsRequest request)
```
    Description copied from interface: AmazonPinpoint
    
    Returns a list of import jobs for a specific segment.
    
    Specified by:
    
    getSegmentImportJobs in interface AmazonPinpoint
    
    Returns:
    
    Result of the GetSegmentImportJobs operation returned by the service.
  - getSegmentVersion
```
public GetSegmentVersionResult getSegmentVersion(GetSegmentVersionRequest request)
```
    Description copied from interface: AmazonPinpoint
    
    Returns information about a segment version.
    
    Specified by:
    
    getSegmentVersion in interface AmazonPinpoint
    
    Returns:
    
    Result of the GetSegmentVersion operation returned by the service.
  - getSegmentVersions
```
public GetSegmentVersionsResult getSegmentVersions(GetSegmentVersionsRequest request)
```
    Description copied from interface: AmazonPinpoint
    
    Returns information about your segment versions.
    
    Specified by:
    
    getSegmentVersions in interface AmazonPinpoint
    
    Returns:
    
    Result of the GetSegmentVersions operation returned by the service.
  - getSegments
```
public GetSegmentsResult getSegments(GetSegmentsRequest request)
```
    Description copied from interface: AmazonPinpoint
    
    Used to get information about your segments.
    
    Specified by:
    
    getSegments in interface AmazonPinpoint
    
    Returns:
    
    Result of the GetSegments operation returned by the service.
  - updateApnsChannel
```
public UpdateApnsChannelResult updateApnsChannel(UpdateApnsChannelRequest request)
```
    Description copied from interface: AmazonPinpoint
    
    Use to update the APNs channel for an app.
    
    Specified by:
    
    updateApnsChannel in interface AmazonPinpoint
    
    Returns:
    
    Result of the UpdateApnsChannel operation returned by the service.
  - updateApplicationSettings
```
public UpdateApplicationSettingsResult updateApplicationSettings(UpdateApplicationSettingsRequest request)
```
    Description copied from interface: AmazonPinpoint
    
    Used to update the settings for an app.
    
    Specified by:
    
    updateApplicationSettings in interface AmazonPinpoint
    
    Returns:
    
    Result of the UpdateApplicationSettings operation returned by the service.
  - updateCampaign
```
public UpdateCampaignResult updateCampaign(UpdateCampaignRequest request)
```
    Description copied from interface: AmazonPinpoint
    
    Use to update a campaign.
    
    Specified by:
    
    updateCampaign in interface AmazonPinpoint
    
    Returns:
    
    Result of the UpdateCampaign operation returned by the service.
  - updateEndpoint
```
public UpdateEndpointResult updateEndpoint(UpdateEndpointRequest request)
```
    Description copied from interface: AmazonPinpoint
    
    Use to update an endpoint.
    
    Specified by:
    
    updateEndpoint in interface AmazonPinpoint
    
    Returns:
    
    Result of the UpdateEndpoint operation returned by the service.
  - updateEndpointsBatch
```
public UpdateEndpointsBatchResult updateEndpointsBatch(UpdateEndpointsBatchRequest request)
```
    Description copied from interface: AmazonPinpoint
    
    Use to update your endpoints.
    
    Specified by:
    
    updateEndpointsBatch in interface AmazonPinpoint
    
    Returns:
    
    Result of the UpdateEndpointsBatch operation returned by the service.
  - updateGcmChannel
```
public UpdateGcmChannelResult updateGcmChannel(UpdateGcmChannelRequest request)
```
    Description copied from interface: AmazonPinpoint
    
    Use to update the GCM channel for an app.
    
    Specified by:
    
    updateGcmChannel in interface AmazonPinpoint
    
    Returns:
    
    Result of the UpdateGcmChannel operation returned by the service.
  - updateSegment
```
public UpdateSegmentResult updateSegment(UpdateSegmentRequest request)
```
    Description copied from interface: AmazonPinpoint
    
    Use to update a segment.
    
    Specified by:
    
    updateSegment in interface AmazonPinpoint
    
    Returns:
    
    Result of the UpdateSegment operation returned by the service.
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AmazonPinpoint
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AmazonPinpoint
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AmazonPinpoint
    
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    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.

Did this page help you?

Class AbstractAmazonPinpoint

Field Summary

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

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setEndpoint

setRegion

createCampaign

createImportJob

createSegment

deleteApnsChannel

deleteCampaign

deleteGcmChannel

deleteSegment

getApnsChannel

getApplicationSettings

getCampaign

getCampaignActivities

getCampaignVersion

getCampaignVersions

getCampaigns

getEndpoint

getGcmChannel

getImportJob

getImportJobs

getSegment

getSegmentImportJobs

getSegmentVersion

getSegmentVersions

getSegments

updateApnsChannel

updateApplicationSettings

updateCampaign

updateEndpoint

updateEndpointsBatch

updateGcmChannel

updateSegment

shutdown

getCachedResponseMetadata