Package software.amazon.awssdk.services.pinpoint

Interface PinpointAsyncClient

All Superinterfaces:

AutoCloseable

@Generated("software.amazon.awssdk:codegen")
public interface PinpointAsyncClient
extends AutoCloseable

Service client for accessing null asynchronously. This can be created using the static builder() method. null

Method Summary

Modifier and Type	Method	Description
static PinpointAsyncClientBuilder	builder()	Create a builder that can be used to configure and create a PinpointAsyncClient.
static PinpointAsyncClient	create()	Create a PinpointAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CompletableFuture<CreateCampaignResponse>	createCampaign(CreateCampaignRequest createCampaignRequest)	Creates or updates a campaign.
default CompletableFuture<CreateImportJobResponse>	createImportJob(CreateImportJobRequest createImportJobRequest)	Creates or updates an import job.
default CompletableFuture<CreateSegmentResponse>	createSegment(CreateSegmentRequest createSegmentRequest)	Used to create or update a segment.
default CompletableFuture<DeleteApnsChannelResponse>	deleteApnsChannel(DeleteApnsChannelRequest deleteApnsChannelRequest)	Deletes the APNs channel for an app.
default CompletableFuture<DeleteApnsSandboxChannelResponse>	deleteApnsSandboxChannel(DeleteApnsSandboxChannelRequest deleteApnsSandboxChannelRequest)	Delete an APNS sandbox channel
default CompletableFuture<DeleteCampaignResponse>	deleteCampaign(DeleteCampaignRequest deleteCampaignRequest)	Deletes a campaign.
default CompletableFuture<DeleteEmailChannelResponse>	deleteEmailChannel(DeleteEmailChannelRequest deleteEmailChannelRequest)	Delete an email channel
default CompletableFuture<DeleteEventStreamResponse>	deleteEventStream(DeleteEventStreamRequest deleteEventStreamRequest)	Deletes the event stream for an app.
default CompletableFuture<DeleteGcmChannelResponse>	deleteGcmChannel(DeleteGcmChannelRequest deleteGcmChannelRequest)	Deletes the GCM channel for an app.
default CompletableFuture<DeleteSegmentResponse>	deleteSegment(DeleteSegmentRequest deleteSegmentRequest)	Deletes a segment.
default CompletableFuture<DeleteSmsChannelResponse>	deleteSmsChannel(DeleteSmsChannelRequest deleteSmsChannelRequest)	Delete an SMS channel
default CompletableFuture<GetApnsChannelResponse>	getApnsChannel(GetApnsChannelRequest getApnsChannelRequest)	Returns information about the APNs channel for an app.
default CompletableFuture<GetApnsSandboxChannelResponse>	getApnsSandboxChannel(GetApnsSandboxChannelRequest getApnsSandboxChannelRequest)	Get an APNS sandbox channel
default CompletableFuture<GetApplicationSettingsResponse>	getApplicationSettings(GetApplicationSettingsRequest getApplicationSettingsRequest)	Used to request the settings for an app.
default CompletableFuture<GetCampaignResponse>	getCampaign(GetCampaignRequest getCampaignRequest)	Returns information about a campaign.
default CompletableFuture<GetCampaignActivitiesResponse>	getCampaignActivities(GetCampaignActivitiesRequest getCampaignActivitiesRequest)	Returns information about the activity performed by a campaign.
default CompletableFuture<GetCampaignsResponse>	getCampaigns(GetCampaignsRequest getCampaignsRequest)	Returns information about your campaigns.
default CompletableFuture<GetCampaignVersionResponse>	getCampaignVersion(GetCampaignVersionRequest getCampaignVersionRequest)	Returns information about a specific version of a campaign.
default CompletableFuture<GetCampaignVersionsResponse>	getCampaignVersions(GetCampaignVersionsRequest getCampaignVersionsRequest)	Returns information about your campaign versions.
default CompletableFuture<GetEmailChannelResponse>	getEmailChannel(GetEmailChannelRequest getEmailChannelRequest)	Get an email channel
default CompletableFuture<GetEndpointResponse>	getEndpoint(GetEndpointRequest getEndpointRequest)	Returns information about an endpoint.
default CompletableFuture<GetEventStreamResponse>	getEventStream(GetEventStreamRequest getEventStreamRequest)	Returns the event stream for an app.
default CompletableFuture<GetGcmChannelResponse>	getGcmChannel(GetGcmChannelRequest getGcmChannelRequest)	Returns information about the GCM channel for an app.
default CompletableFuture<GetImportJobResponse>	getImportJob(GetImportJobRequest getImportJobRequest)	Returns information about an import job.
default CompletableFuture<GetImportJobsResponse>	getImportJobs(GetImportJobsRequest getImportJobsRequest)	Returns information about your import jobs.
default CompletableFuture<GetSegmentResponse>	getSegment(GetSegmentRequest getSegmentRequest)	Returns information about a segment.
default CompletableFuture<GetSegmentImportJobsResponse>	getSegmentImportJobs(GetSegmentImportJobsRequest getSegmentImportJobsRequest)	Returns a list of import jobs for a specific segment.
default CompletableFuture<GetSegmentsResponse>	getSegments(GetSegmentsRequest getSegmentsRequest)	Used to get information about your segments.
default CompletableFuture<GetSegmentVersionResponse>	getSegmentVersion(GetSegmentVersionRequest getSegmentVersionRequest)	Returns information about a segment version.
default CompletableFuture<GetSegmentVersionsResponse>	getSegmentVersions(GetSegmentVersionsRequest getSegmentVersionsRequest)	Returns information about your segment versions.
default CompletableFuture<GetSmsChannelResponse>	getSmsChannel(GetSmsChannelRequest getSmsChannelRequest)	Get an SMS channel
default CompletableFuture<PutEventStreamResponse>	putEventStream(PutEventStreamRequest putEventStreamRequest)	Use to create or update the event stream for an app.
default CompletableFuture<SendMessagesResponse>	sendMessages(SendMessagesRequest sendMessagesRequest)	Send a batch of messages
default CompletableFuture<UpdateApnsChannelResponse>	updateApnsChannel(UpdateApnsChannelRequest updateApnsChannelRequest)	Use to update the APNs channel for an app.
default CompletableFuture<UpdateApnsSandboxChannelResponse>	updateApnsSandboxChannel(UpdateApnsSandboxChannelRequest updateApnsSandboxChannelRequest)	Update an APNS sandbox channel
default CompletableFuture<UpdateApplicationSettingsResponse>	updateApplicationSettings(UpdateApplicationSettingsRequest updateApplicationSettingsRequest)	Used to update the settings for an app.
default CompletableFuture<UpdateCampaignResponse>	updateCampaign(UpdateCampaignRequest updateCampaignRequest)	Use to update a campaign.
default CompletableFuture<UpdateEmailChannelResponse>	updateEmailChannel(UpdateEmailChannelRequest updateEmailChannelRequest)	Update an email channel
default CompletableFuture<UpdateEndpointResponse>	updateEndpoint(UpdateEndpointRequest updateEndpointRequest)	Use to update an endpoint.
default CompletableFuture<UpdateEndpointsBatchResponse>	updateEndpointsBatch(UpdateEndpointsBatchRequest updateEndpointsBatchRequest)	Use to update a batch of endpoints.
default CompletableFuture<UpdateGcmChannelResponse>	updateGcmChannel(UpdateGcmChannelRequest updateGcmChannelRequest)	Use to update the GCM channel for an app.
default CompletableFuture<UpdateSegmentResponse>	updateSegment(UpdateSegmentRequest updateSegmentRequest)	Use to update a segment.
default CompletableFuture<UpdateSmsChannelResponse>	updateSmsChannel(UpdateSmsChannelRequest updateSmsChannelRequest)	Update an SMS channel

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

create

static PinpointAsyncClient create()

Create a PinpointAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static PinpointAsyncClientBuilder builder()

Create a builder that can be used to configure and create a PinpointAsyncClient.

createCampaign

default CompletableFuture<CreateCampaignResponse> createCampaign(CreateCampaignRequest createCampaignRequest)

Creates or updates a campaign.

Parameters:

createCampaignRequest -

Returns:

A Java Future containing the result of the CreateCampaign operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException Simple message object.
• InternalServerErrorException Simple message object.
• ForbiddenException Simple message object.
• NotFoundException Simple message object.
• MethodNotAllowedException Simple message object.
• TooManyRequestsException Simple message object.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

createImportJob

default CompletableFuture<CreateImportJobResponse> createImportJob(CreateImportJobRequest createImportJobRequest)

Creates or updates an import job.

Parameters:

createImportJobRequest -

Returns:

A Java Future containing the result of the CreateImportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException Simple message object.
• InternalServerErrorException Simple message object.
• ForbiddenException Simple message object.
• NotFoundException Simple message object.
• MethodNotAllowedException Simple message object.
• TooManyRequestsException Simple message object.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

createSegment

default CompletableFuture<CreateSegmentResponse> createSegment(CreateSegmentRequest createSegmentRequest)

Used to create or update a segment.

Parameters:

createSegmentRequest -

Returns:

A Java Future containing the result of the CreateSegment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException Simple message object.
• InternalServerErrorException Simple message object.
• ForbiddenException Simple message object.
• NotFoundException Simple message object.
• MethodNotAllowedException Simple message object.
• TooManyRequestsException Simple message object.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

deleteApnsChannel

default CompletableFuture<DeleteApnsChannelResponse> deleteApnsChannel(DeleteApnsChannelRequest deleteApnsChannelRequest)

Deletes the APNs channel for an app.

Parameters:

deleteApnsChannelRequest -

Returns:

A Java Future containing the result of the DeleteApnsChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException Simple message object.
• InternalServerErrorException Simple message object.
• ForbiddenException Simple message object.
• NotFoundException Simple message object.
• MethodNotAllowedException Simple message object.
• TooManyRequestsException Simple message object.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

deleteApnsSandboxChannel

default CompletableFuture<DeleteApnsSandboxChannelResponse> deleteApnsSandboxChannel(DeleteApnsSandboxChannelRequest deleteApnsSandboxChannelRequest)

Delete an APNS sandbox channel

Parameters:

deleteApnsSandboxChannelRequest -

Returns:

A Java Future containing the result of the DeleteApnsSandboxChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException Simple message object.
• InternalServerErrorException Simple message object.
• ForbiddenException Simple message object.
• NotFoundException Simple message object.
• MethodNotAllowedException Simple message object.
• TooManyRequestsException Simple message object.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

deleteCampaign

default CompletableFuture<DeleteCampaignResponse> deleteCampaign(DeleteCampaignRequest deleteCampaignRequest)

Deletes a campaign.

Parameters:

deleteCampaignRequest -

Returns:

A Java Future containing the result of the DeleteCampaign operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException Simple message object.
• InternalServerErrorException Simple message object.
• ForbiddenException Simple message object.
• NotFoundException Simple message object.
• MethodNotAllowedException Simple message object.
• TooManyRequestsException Simple message object.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

deleteEmailChannel

default CompletableFuture<DeleteEmailChannelResponse> deleteEmailChannel(DeleteEmailChannelRequest deleteEmailChannelRequest)

Delete an email channel

Parameters:

deleteEmailChannelRequest -

Returns:

A Java Future containing the result of the DeleteEmailChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException Simple message object.
• InternalServerErrorException Simple message object.
• ForbiddenException Simple message object.
• NotFoundException Simple message object.
• MethodNotAllowedException Simple message object.
• TooManyRequestsException Simple message object.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

deleteEventStream

default CompletableFuture<DeleteEventStreamResponse> deleteEventStream(DeleteEventStreamRequest deleteEventStreamRequest)

Deletes the event stream for an app.

Parameters:

deleteEventStreamRequest - DeleteEventStream Request

Returns:

A Java Future containing the result of the DeleteEventStream operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException Simple message object.
• InternalServerErrorException Simple message object.
• ForbiddenException Simple message object.
• NotFoundException Simple message object.
• MethodNotAllowedException Simple message object.
• TooManyRequestsException Simple message object.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

deleteGcmChannel

default CompletableFuture<DeleteGcmChannelResponse> deleteGcmChannel(DeleteGcmChannelRequest deleteGcmChannelRequest)

Deletes the GCM channel for an app.

Parameters:

deleteGcmChannelRequest -

Returns:

A Java Future containing the result of the DeleteGcmChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException Simple message object.
• InternalServerErrorException Simple message object.
• ForbiddenException Simple message object.
• NotFoundException Simple message object.
• MethodNotAllowedException Simple message object.
• TooManyRequestsException Simple message object.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

deleteSegment

default CompletableFuture<DeleteSegmentResponse> deleteSegment(DeleteSegmentRequest deleteSegmentRequest)

Deletes a segment.

Parameters:

deleteSegmentRequest -

Returns:

A Java Future containing the result of the DeleteSegment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException Simple message object.
• InternalServerErrorException Simple message object.
• ForbiddenException Simple message object.
• NotFoundException Simple message object.
• MethodNotAllowedException Simple message object.
• TooManyRequestsException Simple message object.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

deleteSmsChannel

default CompletableFuture<DeleteSmsChannelResponse> deleteSmsChannel(DeleteSmsChannelRequest deleteSmsChannelRequest)

Delete an SMS channel

Parameters:

deleteSmsChannelRequest -

Returns:

A Java Future containing the result of the DeleteSmsChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException Simple message object.
• InternalServerErrorException Simple message object.
• ForbiddenException Simple message object.
• NotFoundException Simple message object.
• MethodNotAllowedException Simple message object.
• TooManyRequestsException Simple message object.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

getApnsChannel

default CompletableFuture<GetApnsChannelResponse> getApnsChannel(GetApnsChannelRequest getApnsChannelRequest)

Returns information about the APNs channel for an app.

Parameters:

getApnsChannelRequest -

Returns:

A Java Future containing the result of the GetApnsChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException Simple message object.
• InternalServerErrorException Simple message object.
• ForbiddenException Simple message object.
• NotFoundException Simple message object.
• MethodNotAllowedException Simple message object.
• TooManyRequestsException Simple message object.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

getApnsSandboxChannel

default CompletableFuture<GetApnsSandboxChannelResponse> getApnsSandboxChannel(GetApnsSandboxChannelRequest getApnsSandboxChannelRequest)

Get an APNS sandbox channel

Parameters:

getApnsSandboxChannelRequest -

Returns:

A Java Future containing the result of the GetApnsSandboxChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException Simple message object.
• InternalServerErrorException Simple message object.
• ForbiddenException Simple message object.
• NotFoundException Simple message object.
• MethodNotAllowedException Simple message object.
• TooManyRequestsException Simple message object.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

getApplicationSettings

default CompletableFuture<GetApplicationSettingsResponse> getApplicationSettings(GetApplicationSettingsRequest getApplicationSettingsRequest)

Used to request the settings for an app.

Parameters:

getApplicationSettingsRequest -

Returns:

A Java Future containing the result of the GetApplicationSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException Simple message object.
• InternalServerErrorException Simple message object.
• ForbiddenException Simple message object.
• NotFoundException Simple message object.
• MethodNotAllowedException Simple message object.
• TooManyRequestsException Simple message object.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

getCampaign

default CompletableFuture<GetCampaignResponse> getCampaign(GetCampaignRequest getCampaignRequest)

Returns information about a campaign.

Parameters:

getCampaignRequest -

Returns:

A Java Future containing the result of the GetCampaign operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException Simple message object.
• InternalServerErrorException Simple message object.
• ForbiddenException Simple message object.
• NotFoundException Simple message object.
• MethodNotAllowedException Simple message object.
• TooManyRequestsException Simple message object.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

getCampaignActivities

default CompletableFuture<GetCampaignActivitiesResponse> getCampaignActivities(GetCampaignActivitiesRequest getCampaignActivitiesRequest)

Returns information about the activity performed by a campaign.

Parameters:

getCampaignActivitiesRequest -

Returns:

A Java Future containing the result of the GetCampaignActivities operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException Simple message object.
• InternalServerErrorException Simple message object.
• ForbiddenException Simple message object.
• NotFoundException Simple message object.
• MethodNotAllowedException Simple message object.
• TooManyRequestsException Simple message object.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

getCampaignVersion

default CompletableFuture<GetCampaignVersionResponse> getCampaignVersion(GetCampaignVersionRequest getCampaignVersionRequest)

Returns information about a specific version of a campaign.

Parameters:

getCampaignVersionRequest -

Returns:

A Java Future containing the result of the GetCampaignVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException Simple message object.
• InternalServerErrorException Simple message object.
• ForbiddenException Simple message object.
• NotFoundException Simple message object.
• MethodNotAllowedException Simple message object.
• TooManyRequestsException Simple message object.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

getCampaignVersions

default CompletableFuture<GetCampaignVersionsResponse> getCampaignVersions(GetCampaignVersionsRequest getCampaignVersionsRequest)

Returns information about your campaign versions.

Parameters:

getCampaignVersionsRequest -

Returns:

A Java Future containing the result of the GetCampaignVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException Simple message object.
• InternalServerErrorException Simple message object.
• ForbiddenException Simple message object.
• NotFoundException Simple message object.
• MethodNotAllowedException Simple message object.
• TooManyRequestsException Simple message object.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

getCampaigns

default CompletableFuture<GetCampaignsResponse> getCampaigns(GetCampaignsRequest getCampaignsRequest)

Returns information about your campaigns.

Parameters:

getCampaignsRequest -

Returns:

A Java Future containing the result of the GetCampaigns operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException Simple message object.
• InternalServerErrorException Simple message object.
• ForbiddenException Simple message object.
• NotFoundException Simple message object.
• MethodNotAllowedException Simple message object.
• TooManyRequestsException Simple message object.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

getEmailChannel

default CompletableFuture<GetEmailChannelResponse> getEmailChannel(GetEmailChannelRequest getEmailChannelRequest)

Get an email channel

Parameters:

getEmailChannelRequest -

Returns:

A Java Future containing the result of the GetEmailChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException Simple message object.
• InternalServerErrorException Simple message object.
• ForbiddenException Simple message object.
• NotFoundException Simple message object.
• MethodNotAllowedException Simple message object.
• TooManyRequestsException Simple message object.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

getEndpoint

default CompletableFuture<GetEndpointResponse> getEndpoint(GetEndpointRequest getEndpointRequest)

Returns information about an endpoint.

Parameters:

getEndpointRequest -

Returns:

A Java Future containing the result of the GetEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException Simple message object.
• InternalServerErrorException Simple message object.
• ForbiddenException Simple message object.
• NotFoundException Simple message object.
• MethodNotAllowedException Simple message object.
• TooManyRequestsException Simple message object.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

getEventStream

default CompletableFuture<GetEventStreamResponse> getEventStream(GetEventStreamRequest getEventStreamRequest)

Returns the event stream for an app.

Parameters:

getEventStreamRequest - GetEventStream Request

Returns:

A Java Future containing the result of the GetEventStream operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException Simple message object.
• InternalServerErrorException Simple message object.
• ForbiddenException Simple message object.
• NotFoundException Simple message object.
• MethodNotAllowedException Simple message object.
• TooManyRequestsException Simple message object.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

getGcmChannel

default CompletableFuture<GetGcmChannelResponse> getGcmChannel(GetGcmChannelRequest getGcmChannelRequest)

Returns information about the GCM channel for an app.

Parameters:

getGcmChannelRequest -

Returns:

A Java Future containing the result of the GetGcmChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException Simple message object.
• InternalServerErrorException Simple message object.
• ForbiddenException Simple message object.
• NotFoundException Simple message object.
• MethodNotAllowedException Simple message object.
• TooManyRequestsException Simple message object.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

getImportJob

default CompletableFuture<GetImportJobResponse> getImportJob(GetImportJobRequest getImportJobRequest)

Returns information about an import job.

Parameters:

getImportJobRequest -

Returns:

A Java Future containing the result of the GetImportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException Simple message object.
• InternalServerErrorException Simple message object.
• ForbiddenException Simple message object.
• NotFoundException Simple message object.
• MethodNotAllowedException Simple message object.
• TooManyRequestsException Simple message object.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

getImportJobs

default CompletableFuture<GetImportJobsResponse> getImportJobs(GetImportJobsRequest getImportJobsRequest)

Returns information about your import jobs.

Parameters:

getImportJobsRequest -

Returns:

A Java Future containing the result of the GetImportJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException Simple message object.
• InternalServerErrorException Simple message object.
• ForbiddenException Simple message object.
• NotFoundException Simple message object.
• MethodNotAllowedException Simple message object.
• TooManyRequestsException Simple message object.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

getSegment

default CompletableFuture<GetSegmentResponse> getSegment(GetSegmentRequest getSegmentRequest)

Returns information about a segment.

Parameters:

getSegmentRequest -

Returns:

A Java Future containing the result of the GetSegment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException Simple message object.
• InternalServerErrorException Simple message object.
• ForbiddenException Simple message object.
• NotFoundException Simple message object.
• MethodNotAllowedException Simple message object.
• TooManyRequestsException Simple message object.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

getSegmentImportJobs

default CompletableFuture<GetSegmentImportJobsResponse> getSegmentImportJobs(GetSegmentImportJobsRequest getSegmentImportJobsRequest)

Returns a list of import jobs for a specific segment.

Parameters:

getSegmentImportJobsRequest -

Returns:

A Java Future containing the result of the GetSegmentImportJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException Simple message object.
• InternalServerErrorException Simple message object.
• ForbiddenException Simple message object.
• NotFoundException Simple message object.
• MethodNotAllowedException Simple message object.
• TooManyRequestsException Simple message object.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

getSegmentVersion

default CompletableFuture<GetSegmentVersionResponse> getSegmentVersion(GetSegmentVersionRequest getSegmentVersionRequest)

Returns information about a segment version.

Parameters:

getSegmentVersionRequest -

Returns:

A Java Future containing the result of the GetSegmentVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException Simple message object.
• InternalServerErrorException Simple message object.
• ForbiddenException Simple message object.
• NotFoundException Simple message object.
• MethodNotAllowedException Simple message object.
• TooManyRequestsException Simple message object.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

getSegmentVersions

default CompletableFuture<GetSegmentVersionsResponse> getSegmentVersions(GetSegmentVersionsRequest getSegmentVersionsRequest)

Returns information about your segment versions.

Parameters:

getSegmentVersionsRequest -

Returns:

A Java Future containing the result of the GetSegmentVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException Simple message object.
• InternalServerErrorException Simple message object.
• ForbiddenException Simple message object.
• NotFoundException Simple message object.
• MethodNotAllowedException Simple message object.
• TooManyRequestsException Simple message object.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

getSegments

default CompletableFuture<GetSegmentsResponse> getSegments(GetSegmentsRequest getSegmentsRequest)

Used to get information about your segments.

Parameters:

getSegmentsRequest -

Returns:

A Java Future containing the result of the GetSegments operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException Simple message object.
• InternalServerErrorException Simple message object.
• ForbiddenException Simple message object.
• NotFoundException Simple message object.
• MethodNotAllowedException Simple message object.
• TooManyRequestsException Simple message object.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

getSmsChannel

default CompletableFuture<GetSmsChannelResponse> getSmsChannel(GetSmsChannelRequest getSmsChannelRequest)

Get an SMS channel

Parameters:

getSmsChannelRequest -

Returns:

A Java Future containing the result of the GetSmsChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException Simple message object.
• InternalServerErrorException Simple message object.
• ForbiddenException Simple message object.
• NotFoundException Simple message object.
• MethodNotAllowedException Simple message object.
• TooManyRequestsException Simple message object.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

putEventStream

default CompletableFuture<PutEventStreamResponse> putEventStream(PutEventStreamRequest putEventStreamRequest)

Use to create or update the event stream for an app.

Parameters:

putEventStreamRequest - PutEventStream Request

Returns:

A Java Future containing the result of the PutEventStream operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException Simple message object.
• InternalServerErrorException Simple message object.
• ForbiddenException Simple message object.
• NotFoundException Simple message object.
• MethodNotAllowedException Simple message object.
• TooManyRequestsException Simple message object.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

sendMessages

default CompletableFuture<SendMessagesResponse> sendMessages(SendMessagesRequest sendMessagesRequest)

Send a batch of messages

Parameters:

sendMessagesRequest -

Returns:

A Java Future containing the result of the SendMessages operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException Simple message object.
• InternalServerErrorException Simple message object.
• ForbiddenException Simple message object.
• NotFoundException Simple message object.
• MethodNotAllowedException Simple message object.
• TooManyRequestsException Simple message object.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

updateApnsChannel

default CompletableFuture<UpdateApnsChannelResponse> updateApnsChannel(UpdateApnsChannelRequest updateApnsChannelRequest)

Use to update the APNs channel for an app.

Parameters:

updateApnsChannelRequest -

Returns:

A Java Future containing the result of the UpdateApnsChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException Simple message object.
• InternalServerErrorException Simple message object.
• ForbiddenException Simple message object.
• NotFoundException Simple message object.
• MethodNotAllowedException Simple message object.
• TooManyRequestsException Simple message object.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

updateApnsSandboxChannel

default CompletableFuture<UpdateApnsSandboxChannelResponse> updateApnsSandboxChannel(UpdateApnsSandboxChannelRequest updateApnsSandboxChannelRequest)

Update an APNS sandbox channel

Parameters:

updateApnsSandboxChannelRequest -

Returns:

A Java Future containing the result of the UpdateApnsSandboxChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException Simple message object.
• InternalServerErrorException Simple message object.
• ForbiddenException Simple message object.
• NotFoundException Simple message object.
• MethodNotAllowedException Simple message object.
• TooManyRequestsException Simple message object.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

updateApplicationSettings

default CompletableFuture<UpdateApplicationSettingsResponse> updateApplicationSettings(UpdateApplicationSettingsRequest updateApplicationSettingsRequest)

Used to update the settings for an app.

Parameters:

updateApplicationSettingsRequest -

Returns:

A Java Future containing the result of the UpdateApplicationSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException Simple message object.
• InternalServerErrorException Simple message object.
• ForbiddenException Simple message object.
• NotFoundException Simple message object.
• MethodNotAllowedException Simple message object.
• TooManyRequestsException Simple message object.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

updateCampaign

default CompletableFuture<UpdateCampaignResponse> updateCampaign(UpdateCampaignRequest updateCampaignRequest)

Use to update a campaign.

Parameters:

updateCampaignRequest -

Returns:

A Java Future containing the result of the UpdateCampaign operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException Simple message object.
• InternalServerErrorException Simple message object.
• ForbiddenException Simple message object.
• NotFoundException Simple message object.
• MethodNotAllowedException Simple message object.
• TooManyRequestsException Simple message object.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

updateEmailChannel

default CompletableFuture<UpdateEmailChannelResponse> updateEmailChannel(UpdateEmailChannelRequest updateEmailChannelRequest)

Update an email channel

Parameters:

updateEmailChannelRequest -

Returns:

A Java Future containing the result of the UpdateEmailChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException Simple message object.
• InternalServerErrorException Simple message object.
• ForbiddenException Simple message object.
• NotFoundException Simple message object.
• MethodNotAllowedException Simple message object.
• TooManyRequestsException Simple message object.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

updateEndpoint

default CompletableFuture<UpdateEndpointResponse> updateEndpoint(UpdateEndpointRequest updateEndpointRequest)

Use to update an endpoint.

Parameters:

updateEndpointRequest -

Returns:

A Java Future containing the result of the UpdateEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException Simple message object.
• InternalServerErrorException Simple message object.
• ForbiddenException Simple message object.
• NotFoundException Simple message object.
• MethodNotAllowedException Simple message object.
• TooManyRequestsException Simple message object.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

updateEndpointsBatch

default CompletableFuture<UpdateEndpointsBatchResponse> updateEndpointsBatch(UpdateEndpointsBatchRequest updateEndpointsBatchRequest)

Use to update a batch of endpoints.

Parameters:

updateEndpointsBatchRequest -

Returns:

A Java Future containing the result of the UpdateEndpointsBatch operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException Simple message object.
• InternalServerErrorException Simple message object.
• ForbiddenException Simple message object.
• NotFoundException Simple message object.
• MethodNotAllowedException Simple message object.
• TooManyRequestsException Simple message object.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

updateGcmChannel

default CompletableFuture<UpdateGcmChannelResponse> updateGcmChannel(UpdateGcmChannelRequest updateGcmChannelRequest)

Use to update the GCM channel for an app.

Parameters:

updateGcmChannelRequest -

Returns:

A Java Future containing the result of the UpdateGcmChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException Simple message object.
• InternalServerErrorException Simple message object.
• ForbiddenException Simple message object.
• NotFoundException Simple message object.
• MethodNotAllowedException Simple message object.
• TooManyRequestsException Simple message object.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

updateSegment

default CompletableFuture<UpdateSegmentResponse> updateSegment(UpdateSegmentRequest updateSegmentRequest)

Use to update a segment.

Parameters:

updateSegmentRequest -

Returns:

A Java Future containing the result of the UpdateSegment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException Simple message object.
• InternalServerErrorException Simple message object.
• ForbiddenException Simple message object.
• NotFoundException Simple message object.
• MethodNotAllowedException Simple message object.
• TooManyRequestsException Simple message object.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

updateSmsChannel

default CompletableFuture<UpdateSmsChannelResponse> updateSmsChannel(UpdateSmsChannelRequest updateSmsChannelRequest)

Update an SMS channel

Parameters:

updateSmsChannelRequest -

Returns:

A Java Future containing the result of the UpdateSmsChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• BadRequestException Simple message object.
• InternalServerErrorException Simple message object.
• ForbiddenException Simple message object.
• NotFoundException Simple message object.
• MethodNotAllowedException Simple message object.
• TooManyRequestsException Simple message object.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• PinpointException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this