@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonPinpointClient extends AmazonWebServiceClient implements AmazonPinpoint
Doc Engage API - Amazon Pinpoint API
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Constructor and Description |
---|
AmazonPinpointClient()
Deprecated.
|
AmazonPinpointClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AmazonPinpointClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AmazonPinpointClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AmazonPinpointClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AmazonPinpointClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AmazonPinpointClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AmazonPinpointClient(ClientConfiguration clientConfiguration)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
static AmazonPinpointClientBuilder |
builder() |
CreateAppResult |
createApp(CreateAppRequest request)
Creates an application.
|
CreateCampaignResult |
createCampaign(CreateCampaignRequest request)
Creates a new campaign for an application or updates the settings of an existing campaign for an application.
|
CreateEmailTemplateResult |
createEmailTemplate(CreateEmailTemplateRequest request)
Creates a message template for messages that are sent through the email channel.
|
CreateExportJobResult |
createExportJob(CreateExportJobRequest request)
Creates an export job for an application.
|
CreateImportJobResult |
createImportJob(CreateImportJobRequest request)
Creates an import job for an application.
|
CreateInAppTemplateResult |
createInAppTemplate(CreateInAppTemplateRequest request)
Creates a new message template for messages using the in-app message channel.
|
CreateJourneyResult |
createJourney(CreateJourneyRequest request)
Creates a journey for an application.
|
CreatePushTemplateResult |
createPushTemplate(CreatePushTemplateRequest request)
Creates a message template for messages that are sent through a push notification channel.
|
CreateRecommenderConfigurationResult |
createRecommenderConfiguration(CreateRecommenderConfigurationRequest request)
Creates an Amazon Pinpoint configuration for a recommender model.
|
CreateSegmentResult |
createSegment(CreateSegmentRequest request)
Creates a new segment for an application or updates the configuration, dimension, and other settings for an
existing segment that's associated with an application.
|
CreateSmsTemplateResult |
createSmsTemplate(CreateSmsTemplateRequest request)
Creates a message template for messages that are sent through the SMS channel.
|
CreateVoiceTemplateResult |
createVoiceTemplate(CreateVoiceTemplateRequest request)
Creates a message template for messages that are sent through the voice channel.
|
DeleteAdmChannelResult |
deleteAdmChannel(DeleteAdmChannelRequest request)
Disables the ADM channel for an application and deletes any existing settings for the channel.
|
DeleteApnsChannelResult |
deleteApnsChannel(DeleteApnsChannelRequest request)
Disables the APNs channel for an application and deletes any existing settings for the channel.
|
DeleteApnsSandboxChannelResult |
deleteApnsSandboxChannel(DeleteApnsSandboxChannelRequest request)
Disables the APNs sandbox channel for an application and deletes any existing settings for the channel.
|
DeleteApnsVoipChannelResult |
deleteApnsVoipChannel(DeleteApnsVoipChannelRequest request)
Disables the APNs VoIP channel for an application and deletes any existing settings for the channel.
|
DeleteApnsVoipSandboxChannelResult |
deleteApnsVoipSandboxChannel(DeleteApnsVoipSandboxChannelRequest request)
Disables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel.
|
DeleteAppResult |
deleteApp(DeleteAppRequest request)
Deletes an application.
|
DeleteBaiduChannelResult |
deleteBaiduChannel(DeleteBaiduChannelRequest request)
Disables the Baidu channel for an application and deletes any existing settings for the channel.
|
DeleteCampaignResult |
deleteCampaign(DeleteCampaignRequest request)
Deletes a campaign from an application.
|
DeleteEmailChannelResult |
deleteEmailChannel(DeleteEmailChannelRequest request)
Disables the email channel for an application and deletes any existing settings for the channel.
|
DeleteEmailTemplateResult |
deleteEmailTemplate(DeleteEmailTemplateRequest request)
Deletes a message template for messages that were sent through the email channel.
|
DeleteEndpointResult |
deleteEndpoint(DeleteEndpointRequest request)
Deletes an endpoint from an application.
|
DeleteEventStreamResult |
deleteEventStream(DeleteEventStreamRequest request)
Deletes the event stream for an application.
|
DeleteGcmChannelResult |
deleteGcmChannel(DeleteGcmChannelRequest request)
Disables the GCM channel for an application and deletes any existing settings for the channel.
|
DeleteInAppTemplateResult |
deleteInAppTemplate(DeleteInAppTemplateRequest request)
Deletes a message template for messages sent using the in-app message channel.
|
DeleteJourneyResult |
deleteJourney(DeleteJourneyRequest request)
Deletes a journey from an application.
|
DeletePushTemplateResult |
deletePushTemplate(DeletePushTemplateRequest request)
Deletes a message template for messages that were sent through a push notification channel.
|
DeleteRecommenderConfigurationResult |
deleteRecommenderConfiguration(DeleteRecommenderConfigurationRequest request)
Deletes an Amazon Pinpoint configuration for a recommender model.
|
DeleteSegmentResult |
deleteSegment(DeleteSegmentRequest request)
Deletes a segment from an application.
|
DeleteSmsChannelResult |
deleteSmsChannel(DeleteSmsChannelRequest request)
Disables the SMS channel for an application and deletes any existing settings for the channel.
|
DeleteSmsTemplateResult |
deleteSmsTemplate(DeleteSmsTemplateRequest request)
Deletes a message template for messages that were sent through the SMS channel.
|
DeleteUserEndpointsResult |
deleteUserEndpoints(DeleteUserEndpointsRequest request)
Deletes all the endpoints that are associated with a specific user ID.
|
DeleteVoiceChannelResult |
deleteVoiceChannel(DeleteVoiceChannelRequest request)
Disables the voice channel for an application and deletes any existing settings for the channel.
|
DeleteVoiceTemplateResult |
deleteVoiceTemplate(DeleteVoiceTemplateRequest request)
Deletes a message template for messages that were sent through the voice channel.
|
GetAdmChannelResult |
getAdmChannel(GetAdmChannelRequest request)
Retrieves information about the status and settings of the ADM channel for an application.
|
GetApnsChannelResult |
getApnsChannel(GetApnsChannelRequest request)
Retrieves information about the status and settings of the APNs channel for an application.
|
GetApnsSandboxChannelResult |
getApnsSandboxChannel(GetApnsSandboxChannelRequest request)
Retrieves information about the status and settings of the APNs sandbox channel for an application.
|
GetApnsVoipChannelResult |
getApnsVoipChannel(GetApnsVoipChannelRequest request)
Retrieves information about the status and settings of the APNs VoIP channel for an application.
|
GetApnsVoipSandboxChannelResult |
getApnsVoipSandboxChannel(GetApnsVoipSandboxChannelRequest request)
Retrieves information about the status and settings of the APNs VoIP sandbox channel for an application.
|
GetAppResult |
getApp(GetAppRequest request)
Retrieves information about an application.
|
GetApplicationDateRangeKpiResult |
getApplicationDateRangeKpi(GetApplicationDateRangeKpiRequest request)
Retrieves (queries) pre-aggregated data for a standard metric that applies to an application.
|
GetApplicationSettingsResult |
getApplicationSettings(GetApplicationSettingsRequest request)
Retrieves information about the settings for an application.
|
GetAppsResult |
getApps(GetAppsRequest request)
Retrieves information about all the applications that are associated with your Amazon Pinpoint account.
|
GetBaiduChannelResult |
getBaiduChannel(GetBaiduChannelRequest request)
Retrieves information about the status and settings of the Baidu channel for an application.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
|
GetCampaignResult |
getCampaign(GetCampaignRequest request)
Retrieves information about the status, configuration, and other settings for a campaign.
|
GetCampaignActivitiesResult |
getCampaignActivities(GetCampaignActivitiesRequest request)
Retrieves information about all the activities for a campaign.
|
GetCampaignDateRangeKpiResult |
getCampaignDateRangeKpi(GetCampaignDateRangeKpiRequest request)
Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign.
|
GetCampaignsResult |
getCampaigns(GetCampaignsRequest request)
Retrieves information about the status, configuration, and other settings for all the campaigns that are
associated with an application.
|
GetCampaignVersionResult |
getCampaignVersion(GetCampaignVersionRequest request)
Retrieves information about the status, configuration, and other settings for a specific version of a campaign.
|
GetCampaignVersionsResult |
getCampaignVersions(GetCampaignVersionsRequest request)
Retrieves information about the status, configuration, and other settings for all versions of a campaign.
|
GetChannelsResult |
getChannels(GetChannelsRequest request)
Retrieves information about the history and status of each channel for an application.
|
GetEmailChannelResult |
getEmailChannel(GetEmailChannelRequest request)
Retrieves information about the status and settings of the email channel for an application.
|
GetEmailTemplateResult |
getEmailTemplate(GetEmailTemplateRequest request)
Retrieves the content and settings of a message template for messages that are sent through the email channel.
|
GetEndpointResult |
getEndpoint(GetEndpointRequest request)
Retrieves information about the settings and attributes of a specific endpoint for an application.
|
GetEventStreamResult |
getEventStream(GetEventStreamRequest request)
Retrieves information about the event stream settings for an application.
|
GetExportJobResult |
getExportJob(GetExportJobRequest request)
Retrieves information about the status and settings of a specific export job for an application.
|
GetExportJobsResult |
getExportJobs(GetExportJobsRequest request)
Retrieves information about the status and settings of all the export jobs for an application.
|
GetGcmChannelResult |
getGcmChannel(GetGcmChannelRequest request)
Retrieves information about the status and settings of the GCM channel for an application.
|
GetImportJobResult |
getImportJob(GetImportJobRequest request)
Retrieves information about the status and settings of a specific import job for an application.
|
GetImportJobsResult |
getImportJobs(GetImportJobsRequest request)
Retrieves information about the status and settings of all the import jobs for an application.
|
GetInAppMessagesResult |
getInAppMessages(GetInAppMessagesRequest request)
Retrieves the in-app messages targeted for the provided endpoint ID.
|
GetInAppTemplateResult |
getInAppTemplate(GetInAppTemplateRequest request)
Retrieves the content and settings of a message template for messages sent through the in-app channel.
|
GetJourneyResult |
getJourney(GetJourneyRequest request)
Retrieves information about the status, configuration, and other settings for a journey.
|
GetJourneyDateRangeKpiResult |
getJourneyDateRangeKpi(GetJourneyDateRangeKpiRequest request)
Retrieves (queries) pre-aggregated data for a standard engagement metric that applies to a journey.
|
GetJourneyExecutionActivityMetricsResult |
getJourneyExecutionActivityMetrics(GetJourneyExecutionActivityMetricsRequest request)
Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey activity.
|
GetJourneyExecutionMetricsResult |
getJourneyExecutionMetrics(GetJourneyExecutionMetricsRequest request)
Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey.
|
GetJourneyRunExecutionActivityMetricsResult |
getJourneyRunExecutionActivityMetrics(GetJourneyRunExecutionActivityMetricsRequest request)
Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey activity.
|
GetJourneyRunExecutionMetricsResult |
getJourneyRunExecutionMetrics(GetJourneyRunExecutionMetricsRequest request)
Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey.
|
GetJourneyRunsResult |
getJourneyRuns(GetJourneyRunsRequest request)
Provides information about the runs of a journey.
|
GetPushTemplateResult |
getPushTemplate(GetPushTemplateRequest request)
Retrieves the content and settings of a message template for messages that are sent through a push notification
channel.
|
GetRecommenderConfigurationResult |
getRecommenderConfiguration(GetRecommenderConfigurationRequest request)
Retrieves information about an Amazon Pinpoint configuration for a recommender model.
|
GetRecommenderConfigurationsResult |
getRecommenderConfigurations(GetRecommenderConfigurationsRequest request)
Retrieves information about all the recommender model configurations that are associated with your Amazon
Pinpoint account.
|
GetSegmentResult |
getSegment(GetSegmentRequest request)
Retrieves information about the configuration, dimension, and other settings for a specific segment that's
associated with an application.
|
GetSegmentExportJobsResult |
getSegmentExportJobs(GetSegmentExportJobsRequest request)
Retrieves information about the status and settings of the export jobs for a segment.
|
GetSegmentImportJobsResult |
getSegmentImportJobs(GetSegmentImportJobsRequest request)
Retrieves information about the status and settings of the import jobs for a segment.
|
GetSegmentsResult |
getSegments(GetSegmentsRequest request)
Retrieves information about the configuration, dimension, and other settings for all the segments that are
associated with an application.
|
GetSegmentVersionResult |
getSegmentVersion(GetSegmentVersionRequest request)
Retrieves information about the configuration, dimension, and other settings for a specific version of a segment
that's associated with an application.
|
GetSegmentVersionsResult |
getSegmentVersions(GetSegmentVersionsRequest request)
Retrieves information about the configuration, dimension, and other settings for all the versions of a specific
segment that's associated with an application.
|
GetSmsChannelResult |
getSmsChannel(GetSmsChannelRequest request)
Retrieves information about the status and settings of the SMS channel for an application.
|
GetSmsTemplateResult |
getSmsTemplate(GetSmsTemplateRequest request)
Retrieves the content and settings of a message template for messages that are sent through the SMS channel.
|
GetUserEndpointsResult |
getUserEndpoints(GetUserEndpointsRequest request)
Retrieves information about all the endpoints that are associated with a specific user ID.
|
GetVoiceChannelResult |
getVoiceChannel(GetVoiceChannelRequest request)
Retrieves information about the status and settings of the voice channel for an application.
|
GetVoiceTemplateResult |
getVoiceTemplate(GetVoiceTemplateRequest request)
Retrieves the content and settings of a message template for messages that are sent through the voice channel.
|
ListJourneysResult |
listJourneys(ListJourneysRequest request)
Retrieves information about the status, configuration, and other settings for all the journeys that are
associated with an application.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Retrieves all the tags (keys and values) that are associated with an application, campaign, message template, or
segment.
|
ListTemplatesResult |
listTemplates(ListTemplatesRequest request)
Retrieves information about all the message templates that are associated with your Amazon Pinpoint account.
|
ListTemplateVersionsResult |
listTemplateVersions(ListTemplateVersionsRequest request)
Retrieves information about all the versions of a specific message template.
|
PhoneNumberValidateResult |
phoneNumberValidate(PhoneNumberValidateRequest request)
Retrieves information about a phone number.
|
PutEventsResult |
putEvents(PutEventsRequest request)
Creates a new event to record for endpoints, or creates or updates endpoint data that existing events are
associated with.
|
PutEventStreamResult |
putEventStream(PutEventStreamRequest request)
Creates a new event stream for an application or updates the settings of an existing event stream for an
application.
|
RemoveAttributesResult |
removeAttributes(RemoveAttributesRequest request)
Removes one or more custom attributes, of the same attribute type, from the application.
|
SendMessagesResult |
sendMessages(SendMessagesRequest request)
Creates and sends a direct message.
|
SendOTPMessageResult |
sendOTPMessage(SendOTPMessageRequest request)
Send an OTP message
|
SendUsersMessagesResult |
sendUsersMessages(SendUsersMessagesRequest request)
Creates and sends a message to a list of users.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds one or more tags (keys and values) to an application, campaign, message template, or segment.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes one or more tags (keys and values) from an application, campaign, message template, or segment.
|
UpdateAdmChannelResult |
updateAdmChannel(UpdateAdmChannelRequest request)
Enables the ADM channel for an application or updates the status and settings of the ADM channel for an
application.
|
UpdateApnsChannelResult |
updateApnsChannel(UpdateApnsChannelRequest request)
Enables the APNs channel for an application or updates the status and settings of the APNs channel for an
application.
|
UpdateApnsSandboxChannelResult |
updateApnsSandboxChannel(UpdateApnsSandboxChannelRequest request)
Enables the APNs sandbox channel for an application or updates the status and settings of the APNs sandbox
channel for an application.
|
UpdateApnsVoipChannelResult |
updateApnsVoipChannel(UpdateApnsVoipChannelRequest request)
Enables the APNs VoIP channel for an application or updates the status and settings of the APNs VoIP channel for
an application.
|
UpdateApnsVoipSandboxChannelResult |
updateApnsVoipSandboxChannel(UpdateApnsVoipSandboxChannelRequest request)
Enables the APNs VoIP sandbox channel for an application or updates the status and settings of the APNs VoIP
sandbox channel for an application.
|
UpdateApplicationSettingsResult |
updateApplicationSettings(UpdateApplicationSettingsRequest request)
Updates the settings for an application.
|
UpdateBaiduChannelResult |
updateBaiduChannel(UpdateBaiduChannelRequest request)
Enables the Baidu channel for an application or updates the status and settings of the Baidu channel for an
application.
|
UpdateCampaignResult |
updateCampaign(UpdateCampaignRequest request)
Updates the configuration and other settings for a campaign.
|
UpdateEmailChannelResult |
updateEmailChannel(UpdateEmailChannelRequest request)
Enables the email channel for an application or updates the status and settings of the email channel for an
application.
|
UpdateEmailTemplateResult |
updateEmailTemplate(UpdateEmailTemplateRequest request)
Updates an existing message template for messages that are sent through the email channel.
|
UpdateEndpointResult |
updateEndpoint(UpdateEndpointRequest request)
Creates a new endpoint for an application or updates the settings and attributes of an existing endpoint for an
application.
|
UpdateEndpointsBatchResult |
updateEndpointsBatch(UpdateEndpointsBatchRequest request)
Creates a new batch of endpoints for an application or updates the settings and attributes of a batch of existing
endpoints for an application.
|
UpdateGcmChannelResult |
updateGcmChannel(UpdateGcmChannelRequest request)
Enables the GCM channel for an application or updates the status and settings of the GCM channel for an
application.
|
UpdateInAppTemplateResult |
updateInAppTemplate(UpdateInAppTemplateRequest request)
Updates an existing message template for messages sent through the in-app message channel.
|
UpdateJourneyResult |
updateJourney(UpdateJourneyRequest request)
Updates the configuration and other settings for a journey.
|
UpdateJourneyStateResult |
updateJourneyState(UpdateJourneyStateRequest request)
Cancels (stops) an active journey.
|
UpdatePushTemplateResult |
updatePushTemplate(UpdatePushTemplateRequest request)
Updates an existing message template for messages that are sent through a push notification channel.
|
UpdateRecommenderConfigurationResult |
updateRecommenderConfiguration(UpdateRecommenderConfigurationRequest request)
Updates an Amazon Pinpoint configuration for a recommender model.
|
UpdateSegmentResult |
updateSegment(UpdateSegmentRequest request)
Creates a new segment for an application or updates the configuration, dimension, and other settings for an
existing segment that's associated with an application.
|
UpdateSmsChannelResult |
updateSmsChannel(UpdateSmsChannelRequest request)
Enables the SMS channel for an application or updates the status and settings of the SMS channel for an
application.
|
UpdateSmsTemplateResult |
updateSmsTemplate(UpdateSmsTemplateRequest request)
Updates an existing message template for messages that are sent through the SMS channel.
|
UpdateTemplateActiveVersionResult |
updateTemplateActiveVersion(UpdateTemplateActiveVersionRequest request)
Changes the status of a specific version of a message template to active.
|
UpdateVoiceChannelResult |
updateVoiceChannel(UpdateVoiceChannelRequest request)
Enables the voice channel for an application or updates the status and settings of the voice channel for an
application.
|
UpdateVoiceTemplateResult |
updateVoiceTemplate(UpdateVoiceTemplateRequest request)
Updates an existing message template for messages that are sent through the voice channel.
|
VerifyOTPMessageResult |
verifyOTPMessage(VerifyOTPMessageRequest request)
Verify an OTP
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion
@Deprecated public AmazonPinpointClient()
AmazonPinpointClientBuilder.defaultClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
@Deprecated public AmazonPinpointClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
- The client configuration options controlling how this client connects to Amazon Pinpoint (ex: proxy
settings, retry counts, etc.).DefaultAWSCredentialsProviderChain
@Deprecated public AmazonPinpointClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
for example:
AmazonPinpointClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.@Deprecated public AmazonPinpointClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Amazon Pinpoint (ex: proxy
settings, retry counts, etc.).@Deprecated public AmazonPinpointClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.@Deprecated public AmazonPinpointClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Amazon Pinpoint (ex: proxy
settings, retry counts, etc.).@Deprecated public AmazonPinpointClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
and
AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Amazon Pinpoint (ex: proxy
settings, retry counts, etc.).requestMetricCollector
- optional request metric collectorpublic static AmazonPinpointClientBuilder builder()
public CreateAppResult createApp(CreateAppRequest request)
Creates an application.
createApp
in interface AmazonPinpoint
createAppRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public CreateCampaignResult createCampaign(CreateCampaignRequest request)
Creates a new campaign for an application or updates the settings of an existing campaign for an application.
createCampaign
in interface AmazonPinpoint
createCampaignRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public CreateEmailTemplateResult createEmailTemplate(CreateEmailTemplateRequest request)
Creates a message template for messages that are sent through the email channel.
createEmailTemplate
in interface AmazonPinpoint
createEmailTemplateRequest
- MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).public CreateExportJobResult createExportJob(CreateExportJobRequest request)
Creates an export job for an application.
createExportJob
in interface AmazonPinpoint
createExportJobRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public CreateImportJobResult createImportJob(CreateImportJobRequest request)
Creates an import job for an application.
createImportJob
in interface AmazonPinpoint
createImportJobRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public CreateInAppTemplateResult createInAppTemplate(CreateInAppTemplateRequest request)
Creates a new message template for messages using the in-app message channel.
createInAppTemplate
in interface AmazonPinpoint
createInAppTemplateRequest
- MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).public CreateJourneyResult createJourney(CreateJourneyRequest request)
Creates a journey for an application.
createJourney
in interface AmazonPinpoint
createJourneyRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public CreatePushTemplateResult createPushTemplate(CreatePushTemplateRequest request)
Creates a message template for messages that are sent through a push notification channel.
createPushTemplate
in interface AmazonPinpoint
createPushTemplateRequest
- MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).public CreateRecommenderConfigurationResult createRecommenderConfiguration(CreateRecommenderConfigurationRequest request)
Creates an Amazon Pinpoint configuration for a recommender model.
createRecommenderConfiguration
in interface AmazonPinpoint
createRecommenderConfigurationRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public CreateSegmentResult createSegment(CreateSegmentRequest request)
Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.
createSegment
in interface AmazonPinpoint
createSegmentRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public CreateSmsTemplateResult createSmsTemplate(CreateSmsTemplateRequest request)
Creates a message template for messages that are sent through the SMS channel.
createSmsTemplate
in interface AmazonPinpoint
createSmsTemplateRequest
- MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).public CreateVoiceTemplateResult createVoiceTemplate(CreateVoiceTemplateRequest request)
Creates a message template for messages that are sent through the voice channel.
createVoiceTemplate
in interface AmazonPinpoint
createVoiceTemplateRequest
- MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).public DeleteAdmChannelResult deleteAdmChannel(DeleteAdmChannelRequest request)
Disables the ADM channel for an application and deletes any existing settings for the channel.
deleteAdmChannel
in interface AmazonPinpoint
deleteAdmChannelRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public DeleteApnsChannelResult deleteApnsChannel(DeleteApnsChannelRequest request)
Disables the APNs channel for an application and deletes any existing settings for the channel.
deleteApnsChannel
in interface AmazonPinpoint
deleteApnsChannelRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public DeleteApnsSandboxChannelResult deleteApnsSandboxChannel(DeleteApnsSandboxChannelRequest request)
Disables the APNs sandbox channel for an application and deletes any existing settings for the channel.
deleteApnsSandboxChannel
in interface AmazonPinpoint
deleteApnsSandboxChannelRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public DeleteApnsVoipChannelResult deleteApnsVoipChannel(DeleteApnsVoipChannelRequest request)
Disables the APNs VoIP channel for an application and deletes any existing settings for the channel.
deleteApnsVoipChannel
in interface AmazonPinpoint
deleteApnsVoipChannelRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public DeleteApnsVoipSandboxChannelResult deleteApnsVoipSandboxChannel(DeleteApnsVoipSandboxChannelRequest request)
Disables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel.
deleteApnsVoipSandboxChannel
in interface AmazonPinpoint
deleteApnsVoipSandboxChannelRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public DeleteAppResult deleteApp(DeleteAppRequest request)
Deletes an application.
deleteApp
in interface AmazonPinpoint
deleteAppRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public DeleteBaiduChannelResult deleteBaiduChannel(DeleteBaiduChannelRequest request)
Disables the Baidu channel for an application and deletes any existing settings for the channel.
deleteBaiduChannel
in interface AmazonPinpoint
deleteBaiduChannelRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public DeleteCampaignResult deleteCampaign(DeleteCampaignRequest request)
Deletes a campaign from an application.
deleteCampaign
in interface AmazonPinpoint
deleteCampaignRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public DeleteEmailChannelResult deleteEmailChannel(DeleteEmailChannelRequest request)
Disables the email channel for an application and deletes any existing settings for the channel.
deleteEmailChannel
in interface AmazonPinpoint
deleteEmailChannelRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public DeleteEmailTemplateResult deleteEmailTemplate(DeleteEmailTemplateRequest request)
Deletes a message template for messages that were sent through the email channel.
deleteEmailTemplate
in interface AmazonPinpoint
deleteEmailTemplateRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public DeleteEndpointResult deleteEndpoint(DeleteEndpointRequest request)
Deletes an endpoint from an application.
deleteEndpoint
in interface AmazonPinpoint
deleteEndpointRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public DeleteEventStreamResult deleteEventStream(DeleteEventStreamRequest request)
Deletes the event stream for an application.
deleteEventStream
in interface AmazonPinpoint
deleteEventStreamRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public DeleteGcmChannelResult deleteGcmChannel(DeleteGcmChannelRequest request)
Disables the GCM channel for an application and deletes any existing settings for the channel.
deleteGcmChannel
in interface AmazonPinpoint
deleteGcmChannelRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public DeleteInAppTemplateResult deleteInAppTemplate(DeleteInAppTemplateRequest request)
Deletes a message template for messages sent using the in-app message channel.
deleteInAppTemplate
in interface AmazonPinpoint
deleteInAppTemplateRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public DeleteJourneyResult deleteJourney(DeleteJourneyRequest request)
Deletes a journey from an application.
deleteJourney
in interface AmazonPinpoint
deleteJourneyRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public DeletePushTemplateResult deletePushTemplate(DeletePushTemplateRequest request)
Deletes a message template for messages that were sent through a push notification channel.
deletePushTemplate
in interface AmazonPinpoint
deletePushTemplateRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public DeleteRecommenderConfigurationResult deleteRecommenderConfiguration(DeleteRecommenderConfigurationRequest request)
Deletes an Amazon Pinpoint configuration for a recommender model.
deleteRecommenderConfiguration
in interface AmazonPinpoint
deleteRecommenderConfigurationRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public DeleteSegmentResult deleteSegment(DeleteSegmentRequest request)
Deletes a segment from an application.
deleteSegment
in interface AmazonPinpoint
deleteSegmentRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public DeleteSmsChannelResult deleteSmsChannel(DeleteSmsChannelRequest request)
Disables the SMS channel for an application and deletes any existing settings for the channel.
deleteSmsChannel
in interface AmazonPinpoint
deleteSmsChannelRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public DeleteSmsTemplateResult deleteSmsTemplate(DeleteSmsTemplateRequest request)
Deletes a message template for messages that were sent through the SMS channel.
deleteSmsTemplate
in interface AmazonPinpoint
deleteSmsTemplateRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public DeleteUserEndpointsResult deleteUserEndpoints(DeleteUserEndpointsRequest request)
Deletes all the endpoints that are associated with a specific user ID.
deleteUserEndpoints
in interface AmazonPinpoint
deleteUserEndpointsRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public DeleteVoiceChannelResult deleteVoiceChannel(DeleteVoiceChannelRequest request)
Disables the voice channel for an application and deletes any existing settings for the channel.
deleteVoiceChannel
in interface AmazonPinpoint
deleteVoiceChannelRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public DeleteVoiceTemplateResult deleteVoiceTemplate(DeleteVoiceTemplateRequest request)
Deletes a message template for messages that were sent through the voice channel.
deleteVoiceTemplate
in interface AmazonPinpoint
deleteVoiceTemplateRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public GetAdmChannelResult getAdmChannel(GetAdmChannelRequest request)
Retrieves information about the status and settings of the ADM channel for an application.
getAdmChannel
in interface AmazonPinpoint
getAdmChannelRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public GetApnsChannelResult getApnsChannel(GetApnsChannelRequest request)
Retrieves information about the status and settings of the APNs channel for an application.
getApnsChannel
in interface AmazonPinpoint
getApnsChannelRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public GetApnsSandboxChannelResult getApnsSandboxChannel(GetApnsSandboxChannelRequest request)
Retrieves information about the status and settings of the APNs sandbox channel for an application.
getApnsSandboxChannel
in interface AmazonPinpoint
getApnsSandboxChannelRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public GetApnsVoipChannelResult getApnsVoipChannel(GetApnsVoipChannelRequest request)
Retrieves information about the status and settings of the APNs VoIP channel for an application.
getApnsVoipChannel
in interface AmazonPinpoint
getApnsVoipChannelRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public GetApnsVoipSandboxChannelResult getApnsVoipSandboxChannel(GetApnsVoipSandboxChannelRequest request)
Retrieves information about the status and settings of the APNs VoIP sandbox channel for an application.
getApnsVoipSandboxChannel
in interface AmazonPinpoint
getApnsVoipSandboxChannelRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public GetAppResult getApp(GetAppRequest request)
Retrieves information about an application.
getApp
in interface AmazonPinpoint
getAppRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public GetApplicationDateRangeKpiResult getApplicationDateRangeKpi(GetApplicationDateRangeKpiRequest request)
Retrieves (queries) pre-aggregated data for a standard metric that applies to an application.
getApplicationDateRangeKpi
in interface AmazonPinpoint
getApplicationDateRangeKpiRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public GetApplicationSettingsResult getApplicationSettings(GetApplicationSettingsRequest request)
Retrieves information about the settings for an application.
getApplicationSettings
in interface AmazonPinpoint
getApplicationSettingsRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public GetAppsResult getApps(GetAppsRequest request)
Retrieves information about all the applications that are associated with your Amazon Pinpoint account.
getApps
in interface AmazonPinpoint
getAppsRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public GetBaiduChannelResult getBaiduChannel(GetBaiduChannelRequest request)
Retrieves information about the status and settings of the Baidu channel for an application.
getBaiduChannel
in interface AmazonPinpoint
getBaiduChannelRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public GetCampaignResult getCampaign(GetCampaignRequest request)
Retrieves information about the status, configuration, and other settings for a campaign.
getCampaign
in interface AmazonPinpoint
getCampaignRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public GetCampaignActivitiesResult getCampaignActivities(GetCampaignActivitiesRequest request)
Retrieves information about all the activities for a campaign.
getCampaignActivities
in interface AmazonPinpoint
getCampaignActivitiesRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public GetCampaignDateRangeKpiResult getCampaignDateRangeKpi(GetCampaignDateRangeKpiRequest request)
Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign.
getCampaignDateRangeKpi
in interface AmazonPinpoint
getCampaignDateRangeKpiRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public GetCampaignVersionResult getCampaignVersion(GetCampaignVersionRequest request)
Retrieves information about the status, configuration, and other settings for a specific version of a campaign.
getCampaignVersion
in interface AmazonPinpoint
getCampaignVersionRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public GetCampaignVersionsResult getCampaignVersions(GetCampaignVersionsRequest request)
Retrieves information about the status, configuration, and other settings for all versions of a campaign.
getCampaignVersions
in interface AmazonPinpoint
getCampaignVersionsRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public GetCampaignsResult getCampaigns(GetCampaignsRequest request)
Retrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application.
getCampaigns
in interface AmazonPinpoint
getCampaignsRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public GetChannelsResult getChannels(GetChannelsRequest request)
Retrieves information about the history and status of each channel for an application.
getChannels
in interface AmazonPinpoint
getChannelsRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public GetEmailChannelResult getEmailChannel(GetEmailChannelRequest request)
Retrieves information about the status and settings of the email channel for an application.
getEmailChannel
in interface AmazonPinpoint
getEmailChannelRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public GetEmailTemplateResult getEmailTemplate(GetEmailTemplateRequest request)
Retrieves the content and settings of a message template for messages that are sent through the email channel.
getEmailTemplate
in interface AmazonPinpoint
getEmailTemplateRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public GetEndpointResult getEndpoint(GetEndpointRequest request)
Retrieves information about the settings and attributes of a specific endpoint for an application.
getEndpoint
in interface AmazonPinpoint
getEndpointRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public GetEventStreamResult getEventStream(GetEventStreamRequest request)
Retrieves information about the event stream settings for an application.
getEventStream
in interface AmazonPinpoint
getEventStreamRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public GetExportJobResult getExportJob(GetExportJobRequest request)
Retrieves information about the status and settings of a specific export job for an application.
getExportJob
in interface AmazonPinpoint
getExportJobRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public GetExportJobsResult getExportJobs(GetExportJobsRequest request)
Retrieves information about the status and settings of all the export jobs for an application.
getExportJobs
in interface AmazonPinpoint
getExportJobsRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public GetGcmChannelResult getGcmChannel(GetGcmChannelRequest request)
Retrieves information about the status and settings of the GCM channel for an application.
getGcmChannel
in interface AmazonPinpoint
getGcmChannelRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public GetImportJobResult getImportJob(GetImportJobRequest request)
Retrieves information about the status and settings of a specific import job for an application.
getImportJob
in interface AmazonPinpoint
getImportJobRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public GetImportJobsResult getImportJobs(GetImportJobsRequest request)
Retrieves information about the status and settings of all the import jobs for an application.
getImportJobs
in interface AmazonPinpoint
getImportJobsRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public GetInAppMessagesResult getInAppMessages(GetInAppMessagesRequest request)
Retrieves the in-app messages targeted for the provided endpoint ID.
getInAppMessages
in interface AmazonPinpoint
getInAppMessagesRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public GetInAppTemplateResult getInAppTemplate(GetInAppTemplateRequest request)
Retrieves the content and settings of a message template for messages sent through the in-app channel.
getInAppTemplate
in interface AmazonPinpoint
getInAppTemplateRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public GetJourneyResult getJourney(GetJourneyRequest request)
Retrieves information about the status, configuration, and other settings for a journey.
getJourney
in interface AmazonPinpoint
getJourneyRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public GetJourneyDateRangeKpiResult getJourneyDateRangeKpi(GetJourneyDateRangeKpiRequest request)
Retrieves (queries) pre-aggregated data for a standard engagement metric that applies to a journey.
getJourneyDateRangeKpi
in interface AmazonPinpoint
getJourneyDateRangeKpiRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public GetJourneyExecutionActivityMetricsResult getJourneyExecutionActivityMetrics(GetJourneyExecutionActivityMetricsRequest request)
Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey activity.
getJourneyExecutionActivityMetrics
in interface AmazonPinpoint
getJourneyExecutionActivityMetricsRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public GetJourneyExecutionMetricsResult getJourneyExecutionMetrics(GetJourneyExecutionMetricsRequest request)
Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey.
getJourneyExecutionMetrics
in interface AmazonPinpoint
getJourneyExecutionMetricsRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public GetJourneyRunExecutionActivityMetricsResult getJourneyRunExecutionActivityMetrics(GetJourneyRunExecutionActivityMetricsRequest request)
Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey activity.
getJourneyRunExecutionActivityMetrics
in interface AmazonPinpoint
getJourneyRunExecutionActivityMetricsRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public GetJourneyRunExecutionMetricsResult getJourneyRunExecutionMetrics(GetJourneyRunExecutionMetricsRequest request)
Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey.
getJourneyRunExecutionMetrics
in interface AmazonPinpoint
getJourneyRunExecutionMetricsRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public GetJourneyRunsResult getJourneyRuns(GetJourneyRunsRequest request)
Provides information about the runs of a journey.
getJourneyRuns
in interface AmazonPinpoint
getJourneyRunsRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public GetPushTemplateResult getPushTemplate(GetPushTemplateRequest request)
Retrieves the content and settings of a message template for messages that are sent through a push notification channel.
getPushTemplate
in interface AmazonPinpoint
getPushTemplateRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public GetRecommenderConfigurationResult getRecommenderConfiguration(GetRecommenderConfigurationRequest request)
Retrieves information about an Amazon Pinpoint configuration for a recommender model.
getRecommenderConfiguration
in interface AmazonPinpoint
getRecommenderConfigurationRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public GetRecommenderConfigurationsResult getRecommenderConfigurations(GetRecommenderConfigurationsRequest request)
Retrieves information about all the recommender model configurations that are associated with your Amazon Pinpoint account.
getRecommenderConfigurations
in interface AmazonPinpoint
getRecommenderConfigurationsRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public GetSegmentResult getSegment(GetSegmentRequest request)
Retrieves information about the configuration, dimension, and other settings for a specific segment that's associated with an application.
getSegment
in interface AmazonPinpoint
getSegmentRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public GetSegmentExportJobsResult getSegmentExportJobs(GetSegmentExportJobsRequest request)
Retrieves information about the status and settings of the export jobs for a segment.
getSegmentExportJobs
in interface AmazonPinpoint
getSegmentExportJobsRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public GetSegmentImportJobsResult getSegmentImportJobs(GetSegmentImportJobsRequest request)
Retrieves information about the status and settings of the import jobs for a segment.
getSegmentImportJobs
in interface AmazonPinpoint
getSegmentImportJobsRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public GetSegmentVersionResult getSegmentVersion(GetSegmentVersionRequest request)
Retrieves information about the configuration, dimension, and other settings for a specific version of a segment that's associated with an application.
getSegmentVersion
in interface AmazonPinpoint
getSegmentVersionRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public GetSegmentVersionsResult getSegmentVersions(GetSegmentVersionsRequest request)
Retrieves information about the configuration, dimension, and other settings for all the versions of a specific segment that's associated with an application.
getSegmentVersions
in interface AmazonPinpoint
getSegmentVersionsRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public GetSegmentsResult getSegments(GetSegmentsRequest request)
Retrieves information about the configuration, dimension, and other settings for all the segments that are associated with an application.
getSegments
in interface AmazonPinpoint
getSegmentsRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public GetSmsChannelResult getSmsChannel(GetSmsChannelRequest request)
Retrieves information about the status and settings of the SMS channel for an application.
getSmsChannel
in interface AmazonPinpoint
getSmsChannelRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public GetSmsTemplateResult getSmsTemplate(GetSmsTemplateRequest request)
Retrieves the content and settings of a message template for messages that are sent through the SMS channel.
getSmsTemplate
in interface AmazonPinpoint
getSmsTemplateRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public GetUserEndpointsResult getUserEndpoints(GetUserEndpointsRequest request)
Retrieves information about all the endpoints that are associated with a specific user ID.
getUserEndpoints
in interface AmazonPinpoint
getUserEndpointsRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public GetVoiceChannelResult getVoiceChannel(GetVoiceChannelRequest request)
Retrieves information about the status and settings of the voice channel for an application.
getVoiceChannel
in interface AmazonPinpoint
getVoiceChannelRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public GetVoiceTemplateResult getVoiceTemplate(GetVoiceTemplateRequest request)
Retrieves the content and settings of a message template for messages that are sent through the voice channel.
getVoiceTemplate
in interface AmazonPinpoint
getVoiceTemplateRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public ListJourneysResult listJourneys(ListJourneysRequest request)
Retrieves information about the status, configuration, and other settings for all the journeys that are associated with an application.
listJourneys
in interface AmazonPinpoint
listJourneysRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Retrieves all the tags (keys and values) that are associated with an application, campaign, message template, or segment.
listTagsForResource
in interface AmazonPinpoint
listTagsForResourceRequest
- public ListTemplateVersionsResult listTemplateVersions(ListTemplateVersionsRequest request)
Retrieves information about all the versions of a specific message template.
listTemplateVersions
in interface AmazonPinpoint
listTemplateVersionsRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public ListTemplatesResult listTemplates(ListTemplatesRequest request)
Retrieves information about all the message templates that are associated with your Amazon Pinpoint account.
listTemplates
in interface AmazonPinpoint
listTemplatesRequest
- MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).public PhoneNumberValidateResult phoneNumberValidate(PhoneNumberValidateRequest request)
Retrieves information about a phone number.
phoneNumberValidate
in interface AmazonPinpoint
phoneNumberValidateRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public PutEventStreamResult putEventStream(PutEventStreamRequest request)
Creates a new event stream for an application or updates the settings of an existing event stream for an application.
putEventStream
in interface AmazonPinpoint
putEventStreamRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public PutEventsResult putEvents(PutEventsRequest request)
Creates a new event to record for endpoints, or creates or updates endpoint data that existing events are associated with.
putEvents
in interface AmazonPinpoint
putEventsRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public RemoveAttributesResult removeAttributes(RemoveAttributesRequest request)
Removes one or more custom attributes, of the same attribute type, from the application. Existing endpoints still have the attributes but Amazon Pinpoint will stop capturing new or changed values for these attributes.
removeAttributes
in interface AmazonPinpoint
removeAttributesRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public SendMessagesResult sendMessages(SendMessagesRequest request)
Creates and sends a direct message.
sendMessages
in interface AmazonPinpoint
sendMessagesRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public SendOTPMessageResult sendOTPMessage(SendOTPMessageRequest request)
Send an OTP message
sendOTPMessage
in interface AmazonPinpoint
sendOTPMessageRequest
- BadRequestException
- 400 responseInternalServerErrorException
- 500 responsePayloadTooLargeException
- 413 responseForbiddenException
- 403 responseNotFoundException
- 404 responseMethodNotAllowedException
- 405 responseTooManyRequestsException
- 429 responsepublic SendUsersMessagesResult sendUsersMessages(SendUsersMessagesRequest request)
Creates and sends a message to a list of users.
sendUsersMessages
in interface AmazonPinpoint
sendUsersMessagesRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public TagResourceResult tagResource(TagResourceRequest request)
Adds one or more tags (keys and values) to an application, campaign, message template, or segment.
tagResource
in interface AmazonPinpoint
tagResourceRequest
- public UntagResourceResult untagResource(UntagResourceRequest request)
Removes one or more tags (keys and values) from an application, campaign, message template, or segment.
untagResource
in interface AmazonPinpoint
untagResourceRequest
- public UpdateAdmChannelResult updateAdmChannel(UpdateAdmChannelRequest request)
Enables the ADM channel for an application or updates the status and settings of the ADM channel for an application.
updateAdmChannel
in interface AmazonPinpoint
updateAdmChannelRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public UpdateApnsChannelResult updateApnsChannel(UpdateApnsChannelRequest request)
Enables the APNs channel for an application or updates the status and settings of the APNs channel for an application.
updateApnsChannel
in interface AmazonPinpoint
updateApnsChannelRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public UpdateApnsSandboxChannelResult updateApnsSandboxChannel(UpdateApnsSandboxChannelRequest request)
Enables the APNs sandbox channel for an application or updates the status and settings of the APNs sandbox channel for an application.
updateApnsSandboxChannel
in interface AmazonPinpoint
updateApnsSandboxChannelRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public UpdateApnsVoipChannelResult updateApnsVoipChannel(UpdateApnsVoipChannelRequest request)
Enables the APNs VoIP channel for an application or updates the status and settings of the APNs VoIP channel for an application.
updateApnsVoipChannel
in interface AmazonPinpoint
updateApnsVoipChannelRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public UpdateApnsVoipSandboxChannelResult updateApnsVoipSandboxChannel(UpdateApnsVoipSandboxChannelRequest request)
Enables the APNs VoIP sandbox channel for an application or updates the status and settings of the APNs VoIP sandbox channel for an application.
updateApnsVoipSandboxChannel
in interface AmazonPinpoint
updateApnsVoipSandboxChannelRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public UpdateApplicationSettingsResult updateApplicationSettings(UpdateApplicationSettingsRequest request)
Updates the settings for an application.
updateApplicationSettings
in interface AmazonPinpoint
updateApplicationSettingsRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public UpdateBaiduChannelResult updateBaiduChannel(UpdateBaiduChannelRequest request)
Enables the Baidu channel for an application or updates the status and settings of the Baidu channel for an application.
updateBaiduChannel
in interface AmazonPinpoint
updateBaiduChannelRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public UpdateCampaignResult updateCampaign(UpdateCampaignRequest request)
Updates the configuration and other settings for a campaign.
updateCampaign
in interface AmazonPinpoint
updateCampaignRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public UpdateEmailChannelResult updateEmailChannel(UpdateEmailChannelRequest request)
Enables the email channel for an application or updates the status and settings of the email channel for an application.
updateEmailChannel
in interface AmazonPinpoint
updateEmailChannelRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public UpdateEmailTemplateResult updateEmailTemplate(UpdateEmailTemplateRequest request)
Updates an existing message template for messages that are sent through the email channel.
updateEmailTemplate
in interface AmazonPinpoint
updateEmailTemplateRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public UpdateEndpointResult updateEndpoint(UpdateEndpointRequest request)
Creates a new endpoint for an application or updates the settings and attributes of an existing endpoint for an application. You can also use this operation to define custom attributes for an endpoint. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values.
updateEndpoint
in interface AmazonPinpoint
updateEndpointRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public UpdateEndpointsBatchResult updateEndpointsBatch(UpdateEndpointsBatchRequest request)
Creates a new batch of endpoints for an application or updates the settings and attributes of a batch of existing endpoints for an application. You can also use this operation to define custom attributes for a batch of endpoints. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values.
updateEndpointsBatch
in interface AmazonPinpoint
updateEndpointsBatchRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public UpdateGcmChannelResult updateGcmChannel(UpdateGcmChannelRequest request)
Enables the GCM channel for an application or updates the status and settings of the GCM channel for an application.
updateGcmChannel
in interface AmazonPinpoint
updateGcmChannelRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public UpdateInAppTemplateResult updateInAppTemplate(UpdateInAppTemplateRequest request)
Updates an existing message template for messages sent through the in-app message channel.
updateInAppTemplate
in interface AmazonPinpoint
updateInAppTemplateRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public UpdateJourneyResult updateJourney(UpdateJourneyRequest request)
Updates the configuration and other settings for a journey.
updateJourney
in interface AmazonPinpoint
updateJourneyRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).ConflictException
- The request failed due to a conflict with the current state of the specified resource
(ConflictException).public UpdateJourneyStateResult updateJourneyState(UpdateJourneyStateRequest request)
Cancels (stops) an active journey.
updateJourneyState
in interface AmazonPinpoint
updateJourneyStateRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public UpdatePushTemplateResult updatePushTemplate(UpdatePushTemplateRequest request)
Updates an existing message template for messages that are sent through a push notification channel.
updatePushTemplate
in interface AmazonPinpoint
updatePushTemplateRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public UpdateRecommenderConfigurationResult updateRecommenderConfiguration(UpdateRecommenderConfigurationRequest request)
Updates an Amazon Pinpoint configuration for a recommender model.
updateRecommenderConfiguration
in interface AmazonPinpoint
updateRecommenderConfigurationRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public UpdateSegmentResult updateSegment(UpdateSegmentRequest request)
Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.
updateSegment
in interface AmazonPinpoint
updateSegmentRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public UpdateSmsChannelResult updateSmsChannel(UpdateSmsChannelRequest request)
Enables the SMS channel for an application or updates the status and settings of the SMS channel for an application.
updateSmsChannel
in interface AmazonPinpoint
updateSmsChannelRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public UpdateSmsTemplateResult updateSmsTemplate(UpdateSmsTemplateRequest request)
Updates an existing message template for messages that are sent through the SMS channel.
updateSmsTemplate
in interface AmazonPinpoint
updateSmsTemplateRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public UpdateTemplateActiveVersionResult updateTemplateActiveVersion(UpdateTemplateActiveVersionRequest request)
Changes the status of a specific version of a message template to active.
updateTemplateActiveVersion
in interface AmazonPinpoint
updateTemplateActiveVersionRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public UpdateVoiceChannelResult updateVoiceChannel(UpdateVoiceChannelRequest request)
Enables the voice channel for an application or updates the status and settings of the voice channel for an application.
updateVoiceChannel
in interface AmazonPinpoint
updateVoiceChannelRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public UpdateVoiceTemplateResult updateVoiceTemplate(UpdateVoiceTemplateRequest request)
Updates an existing message template for messages that are sent through the voice channel.
updateVoiceTemplate
in interface AmazonPinpoint
updateVoiceTemplateRequest
- BadRequestException
- The request contains a syntax error (BadRequestException).InternalServerErrorException
- The request failed due to an unknown internal server error, exception, or failure
(InternalServerErrorException).PayloadTooLargeException
- The request failed because the payload for the body of the request is too large
(RequestEntityTooLargeException).ForbiddenException
- The request was denied because access to the specified resource is forbidden (ForbiddenException).NotFoundException
- The request failed because the specified resource was not found (NotFoundException).MethodNotAllowedException
- The request failed because the method is not allowed for the specified resource
(MethodNotAllowedException).TooManyRequestsException
- The request failed because too many requests were sent during a certain amount of time
(TooManyRequestsException).public VerifyOTPMessageResult verifyOTPMessage(VerifyOTPMessageRequest request)
Verify an OTP
verifyOTPMessage
in interface AmazonPinpoint
verifyOTPMessageRequest
- BadRequestException
- 400 responseInternalServerErrorException
- 500 responsePayloadTooLargeException
- 413 responseForbiddenException
- 403 responseNotFoundException
- 404 responseMethodNotAllowedException
- 405 responseTooManyRequestsException
- 429 responsepublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata
in interface AmazonPinpoint
request
- The originally executed requestpublic void shutdown()
AmazonWebServiceClient
shutdown
in interface AmazonPinpoint
shutdown
in class AmazonWebServiceClient