AmazonPinpointClient (AWS SDK for Java

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

All Implemented Interfaces:

AmazonPinpoint

Direct Known Subclasses:

AmazonPinpointAsyncClient
```
@ThreadSafe
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 inherited from class com.amazonaws.AmazonWebServiceClient
  LOGGING_AWS_REQUEST_METRIC
- Fields inherited from interface com.amazonaws.services.pinpoint.AmazonPinpoint
  ENDPOINT_PREFIX

Constructor Summary

Constructors
Constructor and Description
`AmazonPinpointClient()` Constructs a new client to invoke service methods on Amazon Pinpoint.
`AmazonPinpointClient(AWSCredentials awsCredentials)` Constructs a new client to invoke service methods on Amazon Pinpoint using the specified AWS account credentials.
`AmazonPinpointClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)` Constructs a new client to invoke service methods on Amazon Pinpoint using the specified AWS account credentials and client configuration options.
`AmazonPinpointClient(AWSCredentialsProvider awsCredentialsProvider)` Constructs a new client to invoke service methods on Amazon Pinpoint using the specified AWS account credentials provider.
`AmazonPinpointClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)` Constructs a new client to invoke service methods on Amazon Pinpoint using the specified AWS account credentials provider and client configuration options.
`AmazonPinpointClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector 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.
`AmazonPinpointClient(ClientConfiguration clientConfiguration)` Constructs a new client to invoke service methods on Amazon Pinpoint.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateCampaignResult`	`createCampaign(CreateCampaignRequest createCampaignRequest)` Creates or updates a campaign.
`CreateImportJobResult`	`createImportJob(CreateImportJobRequest createImportJobRequest)` Creates or updates an import job.
`CreateSegmentResult`	`createSegment(CreateSegmentRequest createSegmentRequest)` Used to create or update a segment.
`DeleteApnsChannelResult`	`deleteApnsChannel(DeleteApnsChannelRequest deleteApnsChannelRequest)` Deletes the APNs channel for an app.
`DeleteCampaignResult`	`deleteCampaign(DeleteCampaignRequest deleteCampaignRequest)` Deletes a campaign.
`DeleteGcmChannelResult`	`deleteGcmChannel(DeleteGcmChannelRequest deleteGcmChannelRequest)` Deletes the GCM channel for an app.
`DeleteSegmentResult`	`deleteSegment(DeleteSegmentRequest deleteSegmentRequest)` Deletes a segment.
`GetApnsChannelResult`	`getApnsChannel(GetApnsChannelRequest getApnsChannelRequest)` Returns information about the APNs channel for an app.
`GetApplicationSettingsResult`	`getApplicationSettings(GetApplicationSettingsRequest getApplicationSettingsRequest)` Used to request the settings for an app.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` 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 getCampaignRequest)` Returns information about a campaign.
`GetCampaignActivitiesResult`	`getCampaignActivities(GetCampaignActivitiesRequest getCampaignActivitiesRequest)` Returns information about the activity performed by a campaign.
`GetCampaignsResult`	`getCampaigns(GetCampaignsRequest getCampaignsRequest)` Returns information about your campaigns.
`GetCampaignVersionResult`	`getCampaignVersion(GetCampaignVersionRequest getCampaignVersionRequest)` Returns information about your campaign versions.
`GetCampaignVersionsResult`	`getCampaignVersions(GetCampaignVersionsRequest getCampaignVersionsRequest)` Returns information about your campaign versions.
`GetEndpointResult`	`getEndpoint(GetEndpointRequest getEndpointRequest)` Returns information about an endpoint.
`GetGcmChannelResult`	`getGcmChannel(GetGcmChannelRequest getGcmChannelRequest)` Returns information about the GCM channel for an app.
`GetImportJobResult`	`getImportJob(GetImportJobRequest getImportJobRequest)` Returns information about an import job.
`GetImportJobsResult`	`getImportJobs(GetImportJobsRequest getImportJobsRequest)` Returns information about your import jobs.
`GetSegmentResult`	`getSegment(GetSegmentRequest getSegmentRequest)` Returns information about a segment.
`GetSegmentImportJobsResult`	`getSegmentImportJobs(GetSegmentImportJobsRequest getSegmentImportJobsRequest)` Returns a list of import jobs for a specific segment.
`GetSegmentsResult`	`getSegments(GetSegmentsRequest getSegmentsRequest)` Used to get information about your segments.
`GetSegmentVersionResult`	`getSegmentVersion(GetSegmentVersionRequest getSegmentVersionRequest)` Returns information about a segment version.
`GetSegmentVersionsResult`	`getSegmentVersions(GetSegmentVersionsRequest getSegmentVersionsRequest)` Returns information about your segment versions.
`UpdateApnsChannelResult`	`updateApnsChannel(UpdateApnsChannelRequest updateApnsChannelRequest)` Use to update the APNs channel for an app.
`UpdateApplicationSettingsResult`	`updateApplicationSettings(UpdateApplicationSettingsRequest updateApplicationSettingsRequest)` Used to update the settings for an app.
`UpdateCampaignResult`	`updateCampaign(UpdateCampaignRequest updateCampaignRequest)` Use to update a campaign.
`UpdateEndpointResult`	`updateEndpoint(UpdateEndpointRequest updateEndpointRequest)` Use to update an endpoint.
`UpdateEndpointsBatchResult`	`updateEndpointsBatch(UpdateEndpointsBatchRequest updateEndpointsBatchRequest)` Use to update your endpoints.
`UpdateGcmChannelResult`	`updateGcmChannel(UpdateGcmChannelRequest updateGcmChannelRequest)` Use to update the GCM channel for an app.
`UpdateSegmentResult`	`updateSegment(UpdateSegmentRequest updateSegmentRequest)` Use to update a segment.

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

Methods inherited from interface com.amazonaws.services.pinpoint.AmazonPinpoint
setEndpoint, setRegion, shutdown

- Constructor Detail
  - AmazonPinpointClient
```
public AmazonPinpointClient()
```
    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
```
public AmazonPinpointClient(ClientConfiguration 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
```
public AmazonPinpointClient(AWSCredentials awsCredentials)
```
    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
```
public AmazonPinpointClient(AWSCredentials awsCredentials,
                            ClientConfiguration 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
```
public AmazonPinpointClient(AWSCredentialsProvider 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
```
public AmazonPinpointClient(AWSCredentialsProvider awsCredentialsProvider,
                            ClientConfiguration 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
```
public AmazonPinpointClient(AWSCredentialsProvider awsCredentialsProvider,
                            ClientConfiguration clientConfiguration,
                            RequestMetricCollector 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
  - createCampaign
```
public CreateCampaignResult createCampaign(CreateCampaignRequest createCampaignRequest)
```
    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
  - createImportJob
```
public CreateImportJobResult createImportJob(CreateImportJobRequest createImportJobRequest)
```
    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
  - createSegment
```
public CreateSegmentResult createSegment(CreateSegmentRequest createSegmentRequest)
```
    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
  - deleteApnsChannel
```
public DeleteApnsChannelResult deleteApnsChannel(DeleteApnsChannelRequest deleteApnsChannelRequest)
```
    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
  - deleteCampaign
```
public DeleteCampaignResult deleteCampaign(DeleteCampaignRequest deleteCampaignRequest)
```
    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
  - deleteGcmChannel
```
public DeleteGcmChannelResult deleteGcmChannel(DeleteGcmChannelRequest deleteGcmChannelRequest)
```
    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
  - deleteSegment
```
public DeleteSegmentResult deleteSegment(DeleteSegmentRequest deleteSegmentRequest)
```
    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
  - getApnsChannel
```
public GetApnsChannelResult getApnsChannel(GetApnsChannelRequest getApnsChannelRequest)
```
    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
  - getApplicationSettings
```
public GetApplicationSettingsResult getApplicationSettings(GetApplicationSettingsRequest getApplicationSettingsRequest)
```
    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
  - getCampaign
```
public GetCampaignResult getCampaign(GetCampaignRequest getCampaignRequest)
```
    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
  - getCampaignActivities
```
public GetCampaignActivitiesResult getCampaignActivities(GetCampaignActivitiesRequest getCampaignActivitiesRequest)
```
    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
  - getCampaignVersion
```
public GetCampaignVersionResult getCampaignVersion(GetCampaignVersionRequest getCampaignVersionRequest)
```
    Returns information about your campaign versions.
    
    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
  - getCampaignVersions
```
public GetCampaignVersionsResult getCampaignVersions(GetCampaignVersionsRequest getCampaignVersionsRequest)
```
    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
  - getCampaigns
```
public GetCampaignsResult getCampaigns(GetCampaignsRequest getCampaignsRequest)
```
    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
  - getEndpoint
```
public GetEndpointResult getEndpoint(GetEndpointRequest getEndpointRequest)
```
    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
  - getGcmChannel
```
public GetGcmChannelResult getGcmChannel(GetGcmChannelRequest getGcmChannelRequest)
```
    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
  - getImportJob
```
public GetImportJobResult getImportJob(GetImportJobRequest getImportJobRequest)
```
    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
  - getImportJobs
```
public GetImportJobsResult getImportJobs(GetImportJobsRequest getImportJobsRequest)
```
    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
  - getSegment
```
public GetSegmentResult getSegment(GetSegmentRequest getSegmentRequest)
```
    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
  - getSegmentImportJobs
```
public GetSegmentImportJobsResult getSegmentImportJobs(GetSegmentImportJobsRequest getSegmentImportJobsRequest)
```
    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
  - getSegmentVersion
```
public GetSegmentVersionResult getSegmentVersion(GetSegmentVersionRequest getSegmentVersionRequest)
```
    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
  - getSegmentVersions
```
public GetSegmentVersionsResult getSegmentVersions(GetSegmentVersionsRequest getSegmentVersionsRequest)
```
    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
  - getSegments
```
public GetSegmentsResult getSegments(GetSegmentsRequest getSegmentsRequest)
```
    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
  - updateApnsChannel
```
public UpdateApnsChannelResult updateApnsChannel(UpdateApnsChannelRequest updateApnsChannelRequest)
```
    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
  - updateApplicationSettings
```
public UpdateApplicationSettingsResult updateApplicationSettings(UpdateApplicationSettingsRequest updateApplicationSettingsRequest)
```
    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
  - updateCampaign
```
public UpdateCampaignResult updateCampaign(UpdateCampaignRequest updateCampaignRequest)
```
    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
  - updateEndpoint
```
public UpdateEndpointResult updateEndpoint(UpdateEndpointRequest updateEndpointRequest)
```
    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 - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
  - updateEndpointsBatch
```
public UpdateEndpointsBatchResult updateEndpointsBatch(UpdateEndpointsBatchRequest updateEndpointsBatchRequest)
```
    Use to update your 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
  - updateGcmChannel
```
public UpdateGcmChannelResult updateGcmChannel(UpdateGcmChannelRequest updateGcmChannelRequest)
```
    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
  - updateSegment
```
public UpdateSegmentResult updateSegment(UpdateSegmentRequest updateSegmentRequest)
```
    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 - 400 response
    
    InternalServerErrorException - 500 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
  - 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.

Did this page help you?

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

Constructor Detail

AmazonPinpointClient

AmazonPinpointClient

AmazonPinpointClient

AmazonPinpointClient

AmazonPinpointClient

AmazonPinpointClient

AmazonPinpointClient

Method Detail

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

getCachedResponseMetadata