PinpointClient (AWS SDK for Java

All Superinterfaces:

AutoCloseable
```
@Generated("software.amazon.awssdk:codegen")
public interface PinpointClient
extends AutoCloseable
```
Service client for accessing null. This can be created using the static builder() method. null

Field Summary

Fields
Modifier and Type Field Description

static String SERVICE_NAME

Fields
Modifier and Type	Field	Description
`static String`	`SERVICE_NAME`

Method Summary

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

Methods inherited from interface java.lang.AutoCloseable
close

Field Detail
- SERVICE_NAME
```
static final String SERVICE_NAME
```
  See Also:
  
  Constant Field Values

Method Detail

create
```
static PinpointClient create()
```
Create a PinpointClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder
```
static PinpointClientBuilder builder()
```
Create a builder that can be used to configure and create a PinpointClient.

createCampaign

default CreateCampaignResponse createCampaign(CreateCampaignRequest createCampaignRequest)
                                       throws BadRequestException,
                                              InternalServerErrorException,
                                              ForbiddenException,
                                              NotFoundException,
                                              MethodNotAllowedException,
                                              TooManyRequestsException,
                                              SdkBaseException,
                                              SdkClientException,
                                              PinpointException

Creates or updates a campaign.

Parameters:: createCampaignRequest -
Returns:: Result of the CreateCampaign operation returned by the service.
Throws:: BadRequestException - Simple message object.; InternalServerErrorException - Simple message object.; ForbiddenException - Simple message object.; NotFoundException - Simple message object.; MethodNotAllowedException - Simple message object.; TooManyRequestsException - Simple message object.; 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

createImportJob

default CreateImportJobResponse createImportJob(CreateImportJobRequest createImportJobRequest)
                                         throws BadRequestException,
                                                InternalServerErrorException,
                                                ForbiddenException,
                                                NotFoundException,
                                                MethodNotAllowedException,
                                                TooManyRequestsException,
                                                SdkBaseException,
                                                SdkClientException,
                                                PinpointException

Creates or updates an import job.

Parameters:: createImportJobRequest -
Returns:: Result of the CreateImportJob operation returned by the service.
Throws:: BadRequestException - Simple message object.; InternalServerErrorException - Simple message object.; ForbiddenException - Simple message object.; NotFoundException - Simple message object.; MethodNotAllowedException - Simple message object.; TooManyRequestsException - Simple message object.; 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

createSegment

default CreateSegmentResponse createSegment(CreateSegmentRequest createSegmentRequest)
                                     throws BadRequestException,
                                            InternalServerErrorException,
                                            ForbiddenException,
                                            NotFoundException,
                                            MethodNotAllowedException,
                                            TooManyRequestsException,
                                            SdkBaseException,
                                            SdkClientException,
                                            PinpointException

Used to create or update a segment.

Parameters:: createSegmentRequest -
Returns:: Result of the CreateSegment operation returned by the service.
Throws:: BadRequestException - Simple message object.; InternalServerErrorException - Simple message object.; ForbiddenException - Simple message object.; NotFoundException - Simple message object.; MethodNotAllowedException - Simple message object.; TooManyRequestsException - Simple message object.; 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

deleteApnsChannel

default DeleteApnsChannelResponse deleteApnsChannel(DeleteApnsChannelRequest deleteApnsChannelRequest)
                                             throws BadRequestException,
                                                    InternalServerErrorException,
                                                    ForbiddenException,
                                                    NotFoundException,
                                                    MethodNotAllowedException,
                                                    TooManyRequestsException,
                                                    SdkBaseException,
                                                    SdkClientException,
                                                    PinpointException

Deletes the APNs channel for an app.

Parameters:: deleteApnsChannelRequest -
Returns:: Result of the DeleteApnsChannel operation returned by the service.
Throws:: BadRequestException - Simple message object.; InternalServerErrorException - Simple message object.; ForbiddenException - Simple message object.; NotFoundException - Simple message object.; MethodNotAllowedException - Simple message object.; TooManyRequestsException - Simple message object.; 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

deleteApnsSandboxChannel

default DeleteApnsSandboxChannelResponse deleteApnsSandboxChannel(DeleteApnsSandboxChannelRequest deleteApnsSandboxChannelRequest)
                                                           throws BadRequestException,
                                                                  InternalServerErrorException,
                                                                  ForbiddenException,
                                                                  NotFoundException,
                                                                  MethodNotAllowedException,
                                                                  TooManyRequestsException,
                                                                  SdkBaseException,
                                                                  SdkClientException,
                                                                  PinpointException

Delete an APNS sandbox channel

Parameters:: deleteApnsSandboxChannelRequest -
Returns:: Result of the DeleteApnsSandboxChannel operation returned by the service.
Throws:: BadRequestException - Simple message object.; InternalServerErrorException - Simple message object.; ForbiddenException - Simple message object.; NotFoundException - Simple message object.; MethodNotAllowedException - Simple message object.; TooManyRequestsException - Simple message object.; 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

deleteCampaign

default DeleteCampaignResponse deleteCampaign(DeleteCampaignRequest deleteCampaignRequest)
                                       throws BadRequestException,
                                              InternalServerErrorException,
                                              ForbiddenException,
                                              NotFoundException,
                                              MethodNotAllowedException,
                                              TooManyRequestsException,
                                              SdkBaseException,
                                              SdkClientException,
                                              PinpointException

Deletes a campaign.

Parameters:: deleteCampaignRequest -
Returns:: Result of the DeleteCampaign operation returned by the service.
Throws:: BadRequestException - Simple message object.; InternalServerErrorException - Simple message object.; ForbiddenException - Simple message object.; NotFoundException - Simple message object.; MethodNotAllowedException - Simple message object.; TooManyRequestsException - Simple message object.; 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

deleteEmailChannel

default DeleteEmailChannelResponse deleteEmailChannel(DeleteEmailChannelRequest deleteEmailChannelRequest)
                                               throws BadRequestException,
                                                      InternalServerErrorException,
                                                      ForbiddenException,
                                                      NotFoundException,
                                                      MethodNotAllowedException,
                                                      TooManyRequestsException,
                                                      SdkBaseException,
                                                      SdkClientException,
                                                      PinpointException

Delete an email channel

Parameters:: deleteEmailChannelRequest -
Returns:: Result of the DeleteEmailChannel operation returned by the service.
Throws:: BadRequestException - Simple message object.; InternalServerErrorException - Simple message object.; ForbiddenException - Simple message object.; NotFoundException - Simple message object.; MethodNotAllowedException - Simple message object.; TooManyRequestsException - Simple message object.; 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

deleteEventStream

default DeleteEventStreamResponse deleteEventStream(DeleteEventStreamRequest deleteEventStreamRequest)
                                             throws BadRequestException,
                                                    InternalServerErrorException,
                                                    ForbiddenException,
                                                    NotFoundException,
                                                    MethodNotAllowedException,
                                                    TooManyRequestsException,
                                                    SdkBaseException,
                                                    SdkClientException,
                                                    PinpointException

Deletes the event stream for an app.

Parameters:: deleteEventStreamRequest - DeleteEventStream Request
Returns:: Result of the DeleteEventStream operation returned by the service.
Throws:: BadRequestException - Simple message object.; InternalServerErrorException - Simple message object.; ForbiddenException - Simple message object.; NotFoundException - Simple message object.; MethodNotAllowedException - Simple message object.; TooManyRequestsException - Simple message object.; 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

deleteGcmChannel

default DeleteGcmChannelResponse deleteGcmChannel(DeleteGcmChannelRequest deleteGcmChannelRequest)
                                           throws BadRequestException,
                                                  InternalServerErrorException,
                                                  ForbiddenException,
                                                  NotFoundException,
                                                  MethodNotAllowedException,
                                                  TooManyRequestsException,
                                                  SdkBaseException,
                                                  SdkClientException,
                                                  PinpointException

Deletes the GCM channel for an app.

Parameters:: deleteGcmChannelRequest -
Returns:: Result of the DeleteGcmChannel operation returned by the service.
Throws:: BadRequestException - Simple message object.; InternalServerErrorException - Simple message object.; ForbiddenException - Simple message object.; NotFoundException - Simple message object.; MethodNotAllowedException - Simple message object.; TooManyRequestsException - Simple message object.; 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

deleteSegment

default DeleteSegmentResponse deleteSegment(DeleteSegmentRequest deleteSegmentRequest)
                                     throws BadRequestException,
                                            InternalServerErrorException,
                                            ForbiddenException,
                                            NotFoundException,
                                            MethodNotAllowedException,
                                            TooManyRequestsException,
                                            SdkBaseException,
                                            SdkClientException,
                                            PinpointException

Deletes a segment.

Parameters:: deleteSegmentRequest -
Returns:: Result of the DeleteSegment operation returned by the service.
Throws:: BadRequestException - Simple message object.; InternalServerErrorException - Simple message object.; ForbiddenException - Simple message object.; NotFoundException - Simple message object.; MethodNotAllowedException - Simple message object.; TooManyRequestsException - Simple message object.; 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

deleteSmsChannel

default DeleteSmsChannelResponse deleteSmsChannel(DeleteSmsChannelRequest deleteSmsChannelRequest)
                                           throws BadRequestException,
                                                  InternalServerErrorException,
                                                  ForbiddenException,
                                                  NotFoundException,
                                                  MethodNotAllowedException,
                                                  TooManyRequestsException,
                                                  SdkBaseException,
                                                  SdkClientException,
                                                  PinpointException

Delete an SMS channel

Parameters:: deleteSmsChannelRequest -
Returns:: Result of the DeleteSmsChannel operation returned by the service.
Throws:: BadRequestException - Simple message object.; InternalServerErrorException - Simple message object.; ForbiddenException - Simple message object.; NotFoundException - Simple message object.; MethodNotAllowedException - Simple message object.; TooManyRequestsException - Simple message object.; 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getApnsChannel

default GetApnsChannelResponse getApnsChannel(GetApnsChannelRequest getApnsChannelRequest)
                                       throws BadRequestException,
                                              InternalServerErrorException,
                                              ForbiddenException,
                                              NotFoundException,
                                              MethodNotAllowedException,
                                              TooManyRequestsException,
                                              SdkBaseException,
                                              SdkClientException,
                                              PinpointException

Returns information about the APNs channel for an app.

Parameters:: getApnsChannelRequest -
Returns:: Result of the GetApnsChannel operation returned by the service.
Throws:: BadRequestException - Simple message object.; InternalServerErrorException - Simple message object.; ForbiddenException - Simple message object.; NotFoundException - Simple message object.; MethodNotAllowedException - Simple message object.; TooManyRequestsException - Simple message object.; 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getApnsSandboxChannel

default GetApnsSandboxChannelResponse getApnsSandboxChannel(GetApnsSandboxChannelRequest getApnsSandboxChannelRequest)
                                                     throws BadRequestException,
                                                            InternalServerErrorException,
                                                            ForbiddenException,
                                                            NotFoundException,
                                                            MethodNotAllowedException,
                                                            TooManyRequestsException,
                                                            SdkBaseException,
                                                            SdkClientException,
                                                            PinpointException

Get an APNS sandbox channel

Parameters:: getApnsSandboxChannelRequest -
Returns:: Result of the GetApnsSandboxChannel operation returned by the service.
Throws:: BadRequestException - Simple message object.; InternalServerErrorException - Simple message object.; ForbiddenException - Simple message object.; NotFoundException - Simple message object.; MethodNotAllowedException - Simple message object.; TooManyRequestsException - Simple message object.; 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getApplicationSettings

default GetApplicationSettingsResponse getApplicationSettings(GetApplicationSettingsRequest getApplicationSettingsRequest)
                                                       throws BadRequestException,
                                                              InternalServerErrorException,
                                                              ForbiddenException,
                                                              NotFoundException,
                                                              MethodNotAllowedException,
                                                              TooManyRequestsException,
                                                              SdkBaseException,
                                                              SdkClientException,
                                                              PinpointException

Used to request the settings for an app.

Parameters:: getApplicationSettingsRequest -
Returns:: Result of the GetApplicationSettings operation returned by the service.
Throws:: BadRequestException - Simple message object.; InternalServerErrorException - Simple message object.; ForbiddenException - Simple message object.; NotFoundException - Simple message object.; MethodNotAllowedException - Simple message object.; TooManyRequestsException - Simple message object.; 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getCampaign

default GetCampaignResponse getCampaign(GetCampaignRequest getCampaignRequest)
                                 throws BadRequestException,
                                        InternalServerErrorException,
                                        ForbiddenException,
                                        NotFoundException,
                                        MethodNotAllowedException,
                                        TooManyRequestsException,
                                        SdkBaseException,
                                        SdkClientException,
                                        PinpointException

Returns information about a campaign.

Parameters:: getCampaignRequest -
Returns:: Result of the GetCampaign operation returned by the service.
Throws:: BadRequestException - Simple message object.; InternalServerErrorException - Simple message object.; ForbiddenException - Simple message object.; NotFoundException - Simple message object.; MethodNotAllowedException - Simple message object.; TooManyRequestsException - Simple message object.; 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getCampaignActivities

default GetCampaignActivitiesResponse getCampaignActivities(GetCampaignActivitiesRequest getCampaignActivitiesRequest)
                                                     throws BadRequestException,
                                                            InternalServerErrorException,
                                                            ForbiddenException,
                                                            NotFoundException,
                                                            MethodNotAllowedException,
                                                            TooManyRequestsException,
                                                            SdkBaseException,
                                                            SdkClientException,
                                                            PinpointException

Returns information about the activity performed by a campaign.

Parameters:: getCampaignActivitiesRequest -
Returns:: Result of the GetCampaignActivities operation returned by the service.
Throws:: BadRequestException - Simple message object.; InternalServerErrorException - Simple message object.; ForbiddenException - Simple message object.; NotFoundException - Simple message object.; MethodNotAllowedException - Simple message object.; TooManyRequestsException - Simple message object.; 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getCampaignVersion

default GetCampaignVersionResponse getCampaignVersion(GetCampaignVersionRequest getCampaignVersionRequest)
                                               throws BadRequestException,
                                                      InternalServerErrorException,
                                                      ForbiddenException,
                                                      NotFoundException,
                                                      MethodNotAllowedException,
                                                      TooManyRequestsException,
                                                      SdkBaseException,
                                                      SdkClientException,
                                                      PinpointException

Returns information about a specific version of a campaign.

Parameters:: getCampaignVersionRequest -
Returns:: Result of the GetCampaignVersion operation returned by the service.
Throws:: BadRequestException - Simple message object.; InternalServerErrorException - Simple message object.; ForbiddenException - Simple message object.; NotFoundException - Simple message object.; MethodNotAllowedException - Simple message object.; TooManyRequestsException - Simple message object.; 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getCampaignVersions

default GetCampaignVersionsResponse getCampaignVersions(GetCampaignVersionsRequest getCampaignVersionsRequest)
                                                 throws BadRequestException,
                                                        InternalServerErrorException,
                                                        ForbiddenException,
                                                        NotFoundException,
                                                        MethodNotAllowedException,
                                                        TooManyRequestsException,
                                                        SdkBaseException,
                                                        SdkClientException,
                                                        PinpointException

Returns information about your campaign versions.

Parameters:: getCampaignVersionsRequest -
Returns:: Result of the GetCampaignVersions operation returned by the service.
Throws:: BadRequestException - Simple message object.; InternalServerErrorException - Simple message object.; ForbiddenException - Simple message object.; NotFoundException - Simple message object.; MethodNotAllowedException - Simple message object.; TooManyRequestsException - Simple message object.; 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getCampaigns

default GetCampaignsResponse getCampaigns(GetCampaignsRequest getCampaignsRequest)
                                   throws BadRequestException,
                                          InternalServerErrorException,
                                          ForbiddenException,
                                          NotFoundException,
                                          MethodNotAllowedException,
                                          TooManyRequestsException,
                                          SdkBaseException,
                                          SdkClientException,
                                          PinpointException

Returns information about your campaigns.

Parameters:: getCampaignsRequest -
Returns:: Result of the GetCampaigns operation returned by the service.
Throws:: BadRequestException - Simple message object.; InternalServerErrorException - Simple message object.; ForbiddenException - Simple message object.; NotFoundException - Simple message object.; MethodNotAllowedException - Simple message object.; TooManyRequestsException - Simple message object.; 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getEmailChannel

default GetEmailChannelResponse getEmailChannel(GetEmailChannelRequest getEmailChannelRequest)
                                         throws BadRequestException,
                                                InternalServerErrorException,
                                                ForbiddenException,
                                                NotFoundException,
                                                MethodNotAllowedException,
                                                TooManyRequestsException,
                                                SdkBaseException,
                                                SdkClientException,
                                                PinpointException

Get an email channel

Parameters:: getEmailChannelRequest -
Returns:: Result of the GetEmailChannel operation returned by the service.
Throws:: BadRequestException - Simple message object.; InternalServerErrorException - Simple message object.; ForbiddenException - Simple message object.; NotFoundException - Simple message object.; MethodNotAllowedException - Simple message object.; TooManyRequestsException - Simple message object.; 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getEndpoint

default GetEndpointResponse getEndpoint(GetEndpointRequest getEndpointRequest)
                                 throws BadRequestException,
                                        InternalServerErrorException,
                                        ForbiddenException,
                                        NotFoundException,
                                        MethodNotAllowedException,
                                        TooManyRequestsException,
                                        SdkBaseException,
                                        SdkClientException,
                                        PinpointException

Returns information about an endpoint.

Parameters:: getEndpointRequest -
Returns:: Result of the GetEndpoint operation returned by the service.
Throws:: BadRequestException - Simple message object.; InternalServerErrorException - Simple message object.; ForbiddenException - Simple message object.; NotFoundException - Simple message object.; MethodNotAllowedException - Simple message object.; TooManyRequestsException - Simple message object.; 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getEventStream

default GetEventStreamResponse getEventStream(GetEventStreamRequest getEventStreamRequest)
                                       throws BadRequestException,
                                              InternalServerErrorException,
                                              ForbiddenException,
                                              NotFoundException,
                                              MethodNotAllowedException,
                                              TooManyRequestsException,
                                              SdkBaseException,
                                              SdkClientException,
                                              PinpointException

Returns the event stream for an app.

Parameters:: getEventStreamRequest - GetEventStream Request
Returns:: Result of the GetEventStream operation returned by the service.
Throws:: BadRequestException - Simple message object.; InternalServerErrorException - Simple message object.; ForbiddenException - Simple message object.; NotFoundException - Simple message object.; MethodNotAllowedException - Simple message object.; TooManyRequestsException - Simple message object.; 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getGcmChannel

default GetGcmChannelResponse getGcmChannel(GetGcmChannelRequest getGcmChannelRequest)
                                     throws BadRequestException,
                                            InternalServerErrorException,
                                            ForbiddenException,
                                            NotFoundException,
                                            MethodNotAllowedException,
                                            TooManyRequestsException,
                                            SdkBaseException,
                                            SdkClientException,
                                            PinpointException

Returns information about the GCM channel for an app.

Parameters:: getGcmChannelRequest -
Returns:: Result of the GetGcmChannel operation returned by the service.
Throws:: BadRequestException - Simple message object.; InternalServerErrorException - Simple message object.; ForbiddenException - Simple message object.; NotFoundException - Simple message object.; MethodNotAllowedException - Simple message object.; TooManyRequestsException - Simple message object.; 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getImportJob

default GetImportJobResponse getImportJob(GetImportJobRequest getImportJobRequest)
                                   throws BadRequestException,
                                          InternalServerErrorException,
                                          ForbiddenException,
                                          NotFoundException,
                                          MethodNotAllowedException,
                                          TooManyRequestsException,
                                          SdkBaseException,
                                          SdkClientException,
                                          PinpointException

Returns information about an import job.

Parameters:: getImportJobRequest -
Returns:: Result of the GetImportJob operation returned by the service.
Throws:: BadRequestException - Simple message object.; InternalServerErrorException - Simple message object.; ForbiddenException - Simple message object.; NotFoundException - Simple message object.; MethodNotAllowedException - Simple message object.; TooManyRequestsException - Simple message object.; 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getImportJobs

default GetImportJobsResponse getImportJobs(GetImportJobsRequest getImportJobsRequest)
                                     throws BadRequestException,
                                            InternalServerErrorException,
                                            ForbiddenException,
                                            NotFoundException,
                                            MethodNotAllowedException,
                                            TooManyRequestsException,
                                            SdkBaseException,
                                            SdkClientException,
                                            PinpointException

Returns information about your import jobs.

Parameters:: getImportJobsRequest -
Returns:: Result of the GetImportJobs operation returned by the service.
Throws:: BadRequestException - Simple message object.; InternalServerErrorException - Simple message object.; ForbiddenException - Simple message object.; NotFoundException - Simple message object.; MethodNotAllowedException - Simple message object.; TooManyRequestsException - Simple message object.; 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getSegment

default GetSegmentResponse getSegment(GetSegmentRequest getSegmentRequest)
                               throws BadRequestException,
                                      InternalServerErrorException,
                                      ForbiddenException,
                                      NotFoundException,
                                      MethodNotAllowedException,
                                      TooManyRequestsException,
                                      SdkBaseException,
                                      SdkClientException,
                                      PinpointException

Returns information about a segment.

Parameters:: getSegmentRequest -
Returns:: Result of the GetSegment operation returned by the service.
Throws:: BadRequestException - Simple message object.; InternalServerErrorException - Simple message object.; ForbiddenException - Simple message object.; NotFoundException - Simple message object.; MethodNotAllowedException - Simple message object.; TooManyRequestsException - Simple message object.; 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getSegmentImportJobs

default GetSegmentImportJobsResponse getSegmentImportJobs(GetSegmentImportJobsRequest getSegmentImportJobsRequest)
                                                   throws BadRequestException,
                                                          InternalServerErrorException,
                                                          ForbiddenException,
                                                          NotFoundException,
                                                          MethodNotAllowedException,
                                                          TooManyRequestsException,
                                                          SdkBaseException,
                                                          SdkClientException,
                                                          PinpointException

Returns a list of import jobs for a specific segment.

Parameters:: getSegmentImportJobsRequest -
Returns:: Result of the GetSegmentImportJobs operation returned by the service.
Throws:: BadRequestException - Simple message object.; InternalServerErrorException - Simple message object.; ForbiddenException - Simple message object.; NotFoundException - Simple message object.; MethodNotAllowedException - Simple message object.; TooManyRequestsException - Simple message object.; 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getSegmentVersion

default GetSegmentVersionResponse getSegmentVersion(GetSegmentVersionRequest getSegmentVersionRequest)
                                             throws BadRequestException,
                                                    InternalServerErrorException,
                                                    ForbiddenException,
                                                    NotFoundException,
                                                    MethodNotAllowedException,
                                                    TooManyRequestsException,
                                                    SdkBaseException,
                                                    SdkClientException,
                                                    PinpointException

Returns information about a segment version.

Parameters:: getSegmentVersionRequest -
Returns:: Result of the GetSegmentVersion operation returned by the service.
Throws:: BadRequestException - Simple message object.; InternalServerErrorException - Simple message object.; ForbiddenException - Simple message object.; NotFoundException - Simple message object.; MethodNotAllowedException - Simple message object.; TooManyRequestsException - Simple message object.; 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getSegmentVersions

default GetSegmentVersionsResponse getSegmentVersions(GetSegmentVersionsRequest getSegmentVersionsRequest)
                                               throws BadRequestException,
                                                      InternalServerErrorException,
                                                      ForbiddenException,
                                                      NotFoundException,
                                                      MethodNotAllowedException,
                                                      TooManyRequestsException,
                                                      SdkBaseException,
                                                      SdkClientException,
                                                      PinpointException

Returns information about your segment versions.

Parameters:: getSegmentVersionsRequest -
Returns:: Result of the GetSegmentVersions operation returned by the service.
Throws:: BadRequestException - Simple message object.; InternalServerErrorException - Simple message object.; ForbiddenException - Simple message object.; NotFoundException - Simple message object.; MethodNotAllowedException - Simple message object.; TooManyRequestsException - Simple message object.; 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getSegments

default GetSegmentsResponse getSegments(GetSegmentsRequest getSegmentsRequest)
                                 throws BadRequestException,
                                        InternalServerErrorException,
                                        ForbiddenException,
                                        NotFoundException,
                                        MethodNotAllowedException,
                                        TooManyRequestsException,
                                        SdkBaseException,
                                        SdkClientException,
                                        PinpointException

Used to get information about your segments.

Parameters:: getSegmentsRequest -
Returns:: Result of the GetSegments operation returned by the service.
Throws:: BadRequestException - Simple message object.; InternalServerErrorException - Simple message object.; ForbiddenException - Simple message object.; NotFoundException - Simple message object.; MethodNotAllowedException - Simple message object.; TooManyRequestsException - Simple message object.; 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

getSmsChannel

default GetSmsChannelResponse getSmsChannel(GetSmsChannelRequest getSmsChannelRequest)
                                     throws BadRequestException,
                                            InternalServerErrorException,
                                            ForbiddenException,
                                            NotFoundException,
                                            MethodNotAllowedException,
                                            TooManyRequestsException,
                                            SdkBaseException,
                                            SdkClientException,
                                            PinpointException

Get an SMS channel

Parameters:: getSmsChannelRequest -
Returns:: Result of the GetSmsChannel operation returned by the service.
Throws:: BadRequestException - Simple message object.; InternalServerErrorException - Simple message object.; ForbiddenException - Simple message object.; NotFoundException - Simple message object.; MethodNotAllowedException - Simple message object.; TooManyRequestsException - Simple message object.; 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

putEventStream

default PutEventStreamResponse putEventStream(PutEventStreamRequest putEventStreamRequest)
                                       throws BadRequestException,
                                              InternalServerErrorException,
                                              ForbiddenException,
                                              NotFoundException,
                                              MethodNotAllowedException,
                                              TooManyRequestsException,
                                              SdkBaseException,
                                              SdkClientException,
                                              PinpointException

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

Parameters:: putEventStreamRequest - PutEventStream Request
Returns:: Result of the PutEventStream operation returned by the service.
Throws:: BadRequestException - Simple message object.; InternalServerErrorException - Simple message object.; ForbiddenException - Simple message object.; NotFoundException - Simple message object.; MethodNotAllowedException - Simple message object.; TooManyRequestsException - Simple message object.; 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

sendMessages

default SendMessagesResponse sendMessages(SendMessagesRequest sendMessagesRequest)
                                   throws BadRequestException,
                                          InternalServerErrorException,
                                          ForbiddenException,
                                          NotFoundException,
                                          MethodNotAllowedException,
                                          TooManyRequestsException,
                                          SdkBaseException,
                                          SdkClientException,
                                          PinpointException

Send a batch of messages

Parameters:: sendMessagesRequest -
Returns:: Result of the SendMessages operation returned by the service.
Throws:: BadRequestException - Simple message object.; InternalServerErrorException - Simple message object.; ForbiddenException - Simple message object.; NotFoundException - Simple message object.; MethodNotAllowedException - Simple message object.; TooManyRequestsException - Simple message object.; 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

updateApnsChannel

default UpdateApnsChannelResponse updateApnsChannel(UpdateApnsChannelRequest updateApnsChannelRequest)
                                             throws BadRequestException,
                                                    InternalServerErrorException,
                                                    ForbiddenException,
                                                    NotFoundException,
                                                    MethodNotAllowedException,
                                                    TooManyRequestsException,
                                                    SdkBaseException,
                                                    SdkClientException,
                                                    PinpointException

Use to update the APNs channel for an app.

Parameters:: updateApnsChannelRequest -
Returns:: Result of the UpdateApnsChannel operation returned by the service.
Throws:: BadRequestException - Simple message object.; InternalServerErrorException - Simple message object.; ForbiddenException - Simple message object.; NotFoundException - Simple message object.; MethodNotAllowedException - Simple message object.; TooManyRequestsException - Simple message object.; 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

updateApnsSandboxChannel

default UpdateApnsSandboxChannelResponse updateApnsSandboxChannel(UpdateApnsSandboxChannelRequest updateApnsSandboxChannelRequest)
                                                           throws BadRequestException,
                                                                  InternalServerErrorException,
                                                                  ForbiddenException,
                                                                  NotFoundException,
                                                                  MethodNotAllowedException,
                                                                  TooManyRequestsException,
                                                                  SdkBaseException,
                                                                  SdkClientException,
                                                                  PinpointException

Update an APNS sandbox channel

Parameters:: updateApnsSandboxChannelRequest -
Returns:: Result of the UpdateApnsSandboxChannel operation returned by the service.
Throws:: BadRequestException - Simple message object.; InternalServerErrorException - Simple message object.; ForbiddenException - Simple message object.; NotFoundException - Simple message object.; MethodNotAllowedException - Simple message object.; TooManyRequestsException - Simple message object.; 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

updateApplicationSettings

default UpdateApplicationSettingsResponse updateApplicationSettings(UpdateApplicationSettingsRequest updateApplicationSettingsRequest)
                                                             throws BadRequestException,
                                                                    InternalServerErrorException,
                                                                    ForbiddenException,
                                                                    NotFoundException,
                                                                    MethodNotAllowedException,
                                                                    TooManyRequestsException,
                                                                    SdkBaseException,
                                                                    SdkClientException,
                                                                    PinpointException

Used to update the settings for an app.

Parameters:: updateApplicationSettingsRequest -
Returns:: Result of the UpdateApplicationSettings operation returned by the service.
Throws:: BadRequestException - Simple message object.; InternalServerErrorException - Simple message object.; ForbiddenException - Simple message object.; NotFoundException - Simple message object.; MethodNotAllowedException - Simple message object.; TooManyRequestsException - Simple message object.; 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

updateCampaign

default UpdateCampaignResponse updateCampaign(UpdateCampaignRequest updateCampaignRequest)
                                       throws BadRequestException,
                                              InternalServerErrorException,
                                              ForbiddenException,
                                              NotFoundException,
                                              MethodNotAllowedException,
                                              TooManyRequestsException,
                                              SdkBaseException,
                                              SdkClientException,
                                              PinpointException

Use to update a campaign.

Parameters:: updateCampaignRequest -
Returns:: Result of the UpdateCampaign operation returned by the service.
Throws:: BadRequestException - Simple message object.; InternalServerErrorException - Simple message object.; ForbiddenException - Simple message object.; NotFoundException - Simple message object.; MethodNotAllowedException - Simple message object.; TooManyRequestsException - Simple message object.; 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

updateEmailChannel

default UpdateEmailChannelResponse updateEmailChannel(UpdateEmailChannelRequest updateEmailChannelRequest)
                                               throws BadRequestException,
                                                      InternalServerErrorException,
                                                      ForbiddenException,
                                                      NotFoundException,
                                                      MethodNotAllowedException,
                                                      TooManyRequestsException,
                                                      SdkBaseException,
                                                      SdkClientException,
                                                      PinpointException

Update an email channel

Parameters:: updateEmailChannelRequest -
Returns:: Result of the UpdateEmailChannel operation returned by the service.
Throws:: BadRequestException - Simple message object.; InternalServerErrorException - Simple message object.; ForbiddenException - Simple message object.; NotFoundException - Simple message object.; MethodNotAllowedException - Simple message object.; TooManyRequestsException - Simple message object.; 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

updateEndpoint

default UpdateEndpointResponse updateEndpoint(UpdateEndpointRequest updateEndpointRequest)
                                       throws BadRequestException,
                                              InternalServerErrorException,
                                              ForbiddenException,
                                              NotFoundException,
                                              MethodNotAllowedException,
                                              TooManyRequestsException,
                                              SdkBaseException,
                                              SdkClientException,
                                              PinpointException

Use to update an endpoint.

Parameters:: updateEndpointRequest -
Returns:: Result of the UpdateEndpoint operation returned by the service.
Throws:: BadRequestException - Simple message object.; InternalServerErrorException - Simple message object.; ForbiddenException - Simple message object.; NotFoundException - Simple message object.; MethodNotAllowedException - Simple message object.; TooManyRequestsException - Simple message object.; 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

updateEndpointsBatch

default UpdateEndpointsBatchResponse updateEndpointsBatch(UpdateEndpointsBatchRequest updateEndpointsBatchRequest)
                                                   throws BadRequestException,
                                                          InternalServerErrorException,
                                                          ForbiddenException,
                                                          NotFoundException,
                                                          MethodNotAllowedException,
                                                          TooManyRequestsException,
                                                          SdkBaseException,
                                                          SdkClientException,
                                                          PinpointException

Use to update a batch of endpoints.

Parameters:: updateEndpointsBatchRequest -
Returns:: Result of the UpdateEndpointsBatch operation returned by the service.
Throws:: BadRequestException - Simple message object.; InternalServerErrorException - Simple message object.; ForbiddenException - Simple message object.; NotFoundException - Simple message object.; MethodNotAllowedException - Simple message object.; TooManyRequestsException - Simple message object.; 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

updateGcmChannel

default UpdateGcmChannelResponse updateGcmChannel(UpdateGcmChannelRequest updateGcmChannelRequest)
                                           throws BadRequestException,
                                                  InternalServerErrorException,
                                                  ForbiddenException,
                                                  NotFoundException,
                                                  MethodNotAllowedException,
                                                  TooManyRequestsException,
                                                  SdkBaseException,
                                                  SdkClientException,
                                                  PinpointException

Use to update the GCM channel for an app.

Parameters:: updateGcmChannelRequest -
Returns:: Result of the UpdateGcmChannel operation returned by the service.
Throws:: BadRequestException - Simple message object.; InternalServerErrorException - Simple message object.; ForbiddenException - Simple message object.; NotFoundException - Simple message object.; MethodNotAllowedException - Simple message object.; TooManyRequestsException - Simple message object.; 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

updateSegment

default UpdateSegmentResponse updateSegment(UpdateSegmentRequest updateSegmentRequest)
                                     throws BadRequestException,
                                            InternalServerErrorException,
                                            ForbiddenException,
                                            NotFoundException,
                                            MethodNotAllowedException,
                                            TooManyRequestsException,
                                            SdkBaseException,
                                            SdkClientException,
                                            PinpointException

Use to update a segment.

Parameters:: updateSegmentRequest -
Returns:: Result of the UpdateSegment operation returned by the service.
Throws:: BadRequestException - Simple message object.; InternalServerErrorException - Simple message object.; ForbiddenException - Simple message object.; NotFoundException - Simple message object.; MethodNotAllowedException - Simple message object.; TooManyRequestsException - Simple message object.; 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

updateSmsChannel

default UpdateSmsChannelResponse updateSmsChannel(UpdateSmsChannelRequest updateSmsChannelRequest)
                                           throws BadRequestException,
                                                  InternalServerErrorException,
                                                  ForbiddenException,
                                                  NotFoundException,
                                                  MethodNotAllowedException,
                                                  TooManyRequestsException,
                                                  SdkBaseException,
                                                  SdkClientException,
                                                  PinpointException

Update an SMS channel

Parameters:: updateSmsChannelRequest -
Returns:: Result of the UpdateSmsChannel operation returned by the service.
Throws:: BadRequestException - Simple message object.; InternalServerErrorException - Simple message object.; ForbiddenException - Simple message object.; NotFoundException - Simple message object.; MethodNotAllowedException - Simple message object.; TooManyRequestsException - Simple message object.; 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

serviceMetadata

static ServiceMetadata serviceMetadata()

Interface PinpointClient

Field Summary