@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonPinpoint
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonPinpoint
instead.
Doc Engage API - Amazon Pinpoint API
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
Modifier and Type | Method and Description |
---|---|
CreateAppResult |
createApp(CreateAppRequest createAppRequest)
Creates an application.
|
CreateCampaignResult |
createCampaign(CreateCampaignRequest createCampaignRequest)
Creates a new campaign for an application or updates the settings of an existing campaign for an application.
|
CreateEmailTemplateResult |
createEmailTemplate(CreateEmailTemplateRequest createEmailTemplateRequest)
Creates a message template for messages that are sent through the email channel.
|
CreateExportJobResult |
createExportJob(CreateExportJobRequest createExportJobRequest)
Creates an export job for an application.
|
CreateImportJobResult |
createImportJob(CreateImportJobRequest createImportJobRequest)
Creates an import job for an application.
|
CreateInAppTemplateResult |
createInAppTemplate(CreateInAppTemplateRequest createInAppTemplateRequest)
Creates a new message template for messages using the in-app message channel.
|
CreateJourneyResult |
createJourney(CreateJourneyRequest createJourneyRequest)
Creates a journey for an application.
|
CreatePushTemplateResult |
createPushTemplate(CreatePushTemplateRequest createPushTemplateRequest)
Creates a message template for messages that are sent through a push notification channel.
|
CreateRecommenderConfigurationResult |
createRecommenderConfiguration(CreateRecommenderConfigurationRequest createRecommenderConfigurationRequest)
Creates an Amazon Pinpoint configuration for a recommender model.
|
CreateSegmentResult |
createSegment(CreateSegmentRequest createSegmentRequest)
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 createSmsTemplateRequest)
Creates a message template for messages that are sent through the SMS channel.
|
CreateVoiceTemplateResult |
createVoiceTemplate(CreateVoiceTemplateRequest createVoiceTemplateRequest)
Creates a message template for messages that are sent through the voice channel.
|
DeleteAdmChannelResult |
deleteAdmChannel(DeleteAdmChannelRequest deleteAdmChannelRequest)
Disables the ADM channel for an application and deletes any existing settings for the channel.
|
DeleteApnsChannelResult |
deleteApnsChannel(DeleteApnsChannelRequest deleteApnsChannelRequest)
Disables the APNs channel for an application and deletes any existing settings for the channel.
|
DeleteApnsSandboxChannelResult |
deleteApnsSandboxChannel(DeleteApnsSandboxChannelRequest deleteApnsSandboxChannelRequest)
Disables the APNs sandbox channel for an application and deletes any existing settings for the channel.
|
DeleteApnsVoipChannelResult |
deleteApnsVoipChannel(DeleteApnsVoipChannelRequest deleteApnsVoipChannelRequest)
Disables the APNs VoIP channel for an application and deletes any existing settings for the channel.
|
DeleteApnsVoipSandboxChannelResult |
deleteApnsVoipSandboxChannel(DeleteApnsVoipSandboxChannelRequest deleteApnsVoipSandboxChannelRequest)
Disables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel.
|
DeleteAppResult |
deleteApp(DeleteAppRequest deleteAppRequest)
Deletes an application.
|
DeleteBaiduChannelResult |
deleteBaiduChannel(DeleteBaiduChannelRequest deleteBaiduChannelRequest)
Disables the Baidu channel for an application and deletes any existing settings for the channel.
|
DeleteCampaignResult |
deleteCampaign(DeleteCampaignRequest deleteCampaignRequest)
Deletes a campaign from an application.
|
DeleteEmailChannelResult |
deleteEmailChannel(DeleteEmailChannelRequest deleteEmailChannelRequest)
Disables the email channel for an application and deletes any existing settings for the channel.
|
DeleteEmailTemplateResult |
deleteEmailTemplate(DeleteEmailTemplateRequest deleteEmailTemplateRequest)
Deletes a message template for messages that were sent through the email channel.
|
DeleteEndpointResult |
deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest)
Deletes an endpoint from an application.
|
DeleteEventStreamResult |
deleteEventStream(DeleteEventStreamRequest deleteEventStreamRequest)
Deletes the event stream for an application.
|
DeleteGcmChannelResult |
deleteGcmChannel(DeleteGcmChannelRequest deleteGcmChannelRequest)
Disables the GCM channel for an application and deletes any existing settings for the channel.
|
DeleteInAppTemplateResult |
deleteInAppTemplate(DeleteInAppTemplateRequest deleteInAppTemplateRequest)
Deletes a message template for messages sent using the in-app message channel.
|
DeleteJourneyResult |
deleteJourney(DeleteJourneyRequest deleteJourneyRequest)
Deletes a journey from an application.
|
DeletePushTemplateResult |
deletePushTemplate(DeletePushTemplateRequest deletePushTemplateRequest)
Deletes a message template for messages that were sent through a push notification channel.
|
DeleteRecommenderConfigurationResult |
deleteRecommenderConfiguration(DeleteRecommenderConfigurationRequest deleteRecommenderConfigurationRequest)
Deletes an Amazon Pinpoint configuration for a recommender model.
|
DeleteSegmentResult |
deleteSegment(DeleteSegmentRequest deleteSegmentRequest)
Deletes a segment from an application.
|
DeleteSmsChannelResult |
deleteSmsChannel(DeleteSmsChannelRequest deleteSmsChannelRequest)
Disables the SMS channel for an application and deletes any existing settings for the channel.
|
DeleteSmsTemplateResult |
deleteSmsTemplate(DeleteSmsTemplateRequest deleteSmsTemplateRequest)
Deletes a message template for messages that were sent through the SMS channel.
|
DeleteUserEndpointsResult |
deleteUserEndpoints(DeleteUserEndpointsRequest deleteUserEndpointsRequest)
Deletes all the endpoints that are associated with a specific user ID.
|
DeleteVoiceChannelResult |
deleteVoiceChannel(DeleteVoiceChannelRequest deleteVoiceChannelRequest)
Disables the voice channel for an application and deletes any existing settings for the channel.
|
DeleteVoiceTemplateResult |
deleteVoiceTemplate(DeleteVoiceTemplateRequest deleteVoiceTemplateRequest)
Deletes a message template for messages that were sent through the voice channel.
|
GetAdmChannelResult |
getAdmChannel(GetAdmChannelRequest getAdmChannelRequest)
Retrieves information about the status and settings of the ADM channel for an application.
|
GetApnsChannelResult |
getApnsChannel(GetApnsChannelRequest getApnsChannelRequest)
Retrieves information about the status and settings of the APNs channel for an application.
|
GetApnsSandboxChannelResult |
getApnsSandboxChannel(GetApnsSandboxChannelRequest getApnsSandboxChannelRequest)
Retrieves information about the status and settings of the APNs sandbox channel for an application.
|
GetApnsVoipChannelResult |
getApnsVoipChannel(GetApnsVoipChannelRequest getApnsVoipChannelRequest)
Retrieves information about the status and settings of the APNs VoIP channel for an application.
|
GetApnsVoipSandboxChannelResult |
getApnsVoipSandboxChannel(GetApnsVoipSandboxChannelRequest getApnsVoipSandboxChannelRequest)
Retrieves information about the status and settings of the APNs VoIP sandbox channel for an application.
|
GetAppResult |
getApp(GetAppRequest getAppRequest)
Retrieves information about an application.
|
GetApplicationDateRangeKpiResult |
getApplicationDateRangeKpi(GetApplicationDateRangeKpiRequest getApplicationDateRangeKpiRequest)
Retrieves (queries) pre-aggregated data for a standard metric that applies to an application.
|
GetApplicationSettingsResult |
getApplicationSettings(GetApplicationSettingsRequest getApplicationSettingsRequest)
Retrieves information about the settings for an application.
|
GetAppsResult |
getApps(GetAppsRequest getAppsRequest)
Retrieves information about all the applications that are associated with your Amazon Pinpoint account.
|
GetBaiduChannelResult |
getBaiduChannel(GetBaiduChannelRequest getBaiduChannelRequest)
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 getCampaignRequest)
Retrieves information about the status, configuration, and other settings for a campaign.
|
GetCampaignActivitiesResult |
getCampaignActivities(GetCampaignActivitiesRequest getCampaignActivitiesRequest)
Retrieves information about all the activities for a campaign.
|
GetCampaignDateRangeKpiResult |
getCampaignDateRangeKpi(GetCampaignDateRangeKpiRequest getCampaignDateRangeKpiRequest)
Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign.
|
GetCampaignsResult |
getCampaigns(GetCampaignsRequest getCampaignsRequest)
Retrieves information about the status, configuration, and other settings for all the campaigns that are
associated with an application.
|
GetCampaignVersionResult |
getCampaignVersion(GetCampaignVersionRequest getCampaignVersionRequest)
Retrieves information about the status, configuration, and other settings for a specific version of a campaign.
|
GetCampaignVersionsResult |
getCampaignVersions(GetCampaignVersionsRequest getCampaignVersionsRequest)
Retrieves information about the status, configuration, and other settings for all versions of a campaign.
|
GetChannelsResult |
getChannels(GetChannelsRequest getChannelsRequest)
Retrieves information about the history and status of each channel for an application.
|
GetEmailChannelResult |
getEmailChannel(GetEmailChannelRequest getEmailChannelRequest)
Retrieves information about the status and settings of the email channel for an application.
|
GetEmailTemplateResult |
getEmailTemplate(GetEmailTemplateRequest getEmailTemplateRequest)
Retrieves the content and settings of a message template for messages that are sent through the email channel.
|
GetEndpointResult |
getEndpoint(GetEndpointRequest getEndpointRequest)
Retrieves information about the settings and attributes of a specific endpoint for an application.
|
GetEventStreamResult |
getEventStream(GetEventStreamRequest getEventStreamRequest)
Retrieves information about the event stream settings for an application.
|
GetExportJobResult |
getExportJob(GetExportJobRequest getExportJobRequest)
Retrieves information about the status and settings of a specific export job for an application.
|
GetExportJobsResult |
getExportJobs(GetExportJobsRequest getExportJobsRequest)
Retrieves information about the status and settings of all the export jobs for an application.
|
GetGcmChannelResult |
getGcmChannel(GetGcmChannelRequest getGcmChannelRequest)
Retrieves information about the status and settings of the GCM channel for an application.
|
GetImportJobResult |
getImportJob(GetImportJobRequest getImportJobRequest)
Retrieves information about the status and settings of a specific import job for an application.
|
GetImportJobsResult |
getImportJobs(GetImportJobsRequest getImportJobsRequest)
Retrieves information about the status and settings of all the import jobs for an application.
|
GetInAppMessagesResult |
getInAppMessages(GetInAppMessagesRequest getInAppMessagesRequest)
Retrieves the in-app messages targeted for the provided endpoint ID.
|
GetInAppTemplateResult |
getInAppTemplate(GetInAppTemplateRequest getInAppTemplateRequest)
Retrieves the content and settings of a message template for messages sent through the in-app channel.
|
GetJourneyResult |
getJourney(GetJourneyRequest getJourneyRequest)
Retrieves information about the status, configuration, and other settings for a journey.
|
GetJourneyDateRangeKpiResult |
getJourneyDateRangeKpi(GetJourneyDateRangeKpiRequest getJourneyDateRangeKpiRequest)
Retrieves (queries) pre-aggregated data for a standard engagement metric that applies to a journey.
|
GetJourneyExecutionActivityMetricsResult |
getJourneyExecutionActivityMetrics(GetJourneyExecutionActivityMetricsRequest getJourneyExecutionActivityMetricsRequest)
Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey activity.
|
GetJourneyExecutionMetricsResult |
getJourneyExecutionMetrics(GetJourneyExecutionMetricsRequest getJourneyExecutionMetricsRequest)
Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey.
|
GetJourneyRunExecutionActivityMetricsResult |
getJourneyRunExecutionActivityMetrics(GetJourneyRunExecutionActivityMetricsRequest getJourneyRunExecutionActivityMetricsRequest)
Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey activity.
|
GetJourneyRunExecutionMetricsResult |
getJourneyRunExecutionMetrics(GetJourneyRunExecutionMetricsRequest getJourneyRunExecutionMetricsRequest)
Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey.
|
GetJourneyRunsResult |
getJourneyRuns(GetJourneyRunsRequest getJourneyRunsRequest)
Provides information about the runs of a journey.
|
GetPushTemplateResult |
getPushTemplate(GetPushTemplateRequest getPushTemplateRequest)
Retrieves the content and settings of a message template for messages that are sent through a push notification
channel.
|
GetRecommenderConfigurationResult |
getRecommenderConfiguration(GetRecommenderConfigurationRequest getRecommenderConfigurationRequest)
Retrieves information about an Amazon Pinpoint configuration for a recommender model.
|
GetRecommenderConfigurationsResult |
getRecommenderConfigurations(GetRecommenderConfigurationsRequest getRecommenderConfigurationsRequest)
Retrieves information about all the recommender model configurations that are associated with your Amazon
Pinpoint account.
|
GetSegmentResult |
getSegment(GetSegmentRequest getSegmentRequest)
Retrieves information about the configuration, dimension, and other settings for a specific segment that's
associated with an application.
|
GetSegmentExportJobsResult |
getSegmentExportJobs(GetSegmentExportJobsRequest getSegmentExportJobsRequest)
Retrieves information about the status and settings of the export jobs for a segment.
|
GetSegmentImportJobsResult |
getSegmentImportJobs(GetSegmentImportJobsRequest getSegmentImportJobsRequest)
Retrieves information about the status and settings of the import jobs for a segment.
|
GetSegmentsResult |
getSegments(GetSegmentsRequest getSegmentsRequest)
Retrieves information about the configuration, dimension, and other settings for all the segments that are
associated with an application.
|
GetSegmentVersionResult |
getSegmentVersion(GetSegmentVersionRequest getSegmentVersionRequest)
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 getSegmentVersionsRequest)
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 getSmsChannelRequest)
Retrieves information about the status and settings of the SMS channel for an application.
|
GetSmsTemplateResult |
getSmsTemplate(GetSmsTemplateRequest getSmsTemplateRequest)
Retrieves the content and settings of a message template for messages that are sent through the SMS channel.
|
GetUserEndpointsResult |
getUserEndpoints(GetUserEndpointsRequest getUserEndpointsRequest)
Retrieves information about all the endpoints that are associated with a specific user ID.
|
GetVoiceChannelResult |
getVoiceChannel(GetVoiceChannelRequest getVoiceChannelRequest)
Retrieves information about the status and settings of the voice channel for an application.
|
GetVoiceTemplateResult |
getVoiceTemplate(GetVoiceTemplateRequest getVoiceTemplateRequest)
Retrieves the content and settings of a message template for messages that are sent through the voice channel.
|
ListJourneysResult |
listJourneys(ListJourneysRequest listJourneysRequest)
Retrieves information about the status, configuration, and other settings for all the journeys that are
associated with an application.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Retrieves all the tags (keys and values) that are associated with an application, campaign, message template, or
segment.
|
ListTemplatesResult |
listTemplates(ListTemplatesRequest listTemplatesRequest)
Retrieves information about all the message templates that are associated with your Amazon Pinpoint account.
|
ListTemplateVersionsResult |
listTemplateVersions(ListTemplateVersionsRequest listTemplateVersionsRequest)
Retrieves information about all the versions of a specific message template.
|
PhoneNumberValidateResult |
phoneNumberValidate(PhoneNumberValidateRequest phoneNumberValidateRequest)
Retrieves information about a phone number.
|
PutEventsResult |
putEvents(PutEventsRequest putEventsRequest)
Creates a new event to record for endpoints, or creates or updates endpoint data that existing events are
associated with.
|
PutEventStreamResult |
putEventStream(PutEventStreamRequest putEventStreamRequest)
Creates a new event stream for an application or updates the settings of an existing event stream for an
application.
|
RemoveAttributesResult |
removeAttributes(RemoveAttributesRequest removeAttributesRequest)
Removes one or more custom attributes, of the same attribute type, from the application.
|
SendMessagesResult |
sendMessages(SendMessagesRequest sendMessagesRequest)
Creates and sends a direct message.
|
SendOTPMessageResult |
sendOTPMessage(SendOTPMessageRequest sendOTPMessageRequest)
Send an OTP message
|
SendUsersMessagesResult |
sendUsersMessages(SendUsersMessagesRequest sendUsersMessagesRequest)
Creates and sends a message to a list of users.
|
void |
setEndpoint(String endpoint)
Deprecated.
use
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion)); |
void |
setRegion(Region region)
Deprecated.
use
AwsClientBuilder#setRegion(String) |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Adds one or more tags (keys and values) to an application, campaign, message template, or segment.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Removes one or more tags (keys and values) from an application, campaign, message template, or segment.
|
UpdateAdmChannelResult |
updateAdmChannel(UpdateAdmChannelRequest updateAdmChannelRequest)
Enables the ADM channel for an application or updates the status and settings of the ADM channel for an
application.
|
UpdateApnsChannelResult |
updateApnsChannel(UpdateApnsChannelRequest updateApnsChannelRequest)
Enables the APNs channel for an application or updates the status and settings of the APNs channel for an
application.
|
UpdateApnsSandboxChannelResult |
updateApnsSandboxChannel(UpdateApnsSandboxChannelRequest updateApnsSandboxChannelRequest)
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 updateApnsVoipChannelRequest)
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 updateApnsVoipSandboxChannelRequest)
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 updateApplicationSettingsRequest)
Updates the settings for an application.
|
UpdateBaiduChannelResult |
updateBaiduChannel(UpdateBaiduChannelRequest updateBaiduChannelRequest)
Enables the Baidu channel for an application or updates the status and settings of the Baidu channel for an
application.
|
UpdateCampaignResult |
updateCampaign(UpdateCampaignRequest updateCampaignRequest)
Updates the configuration and other settings for a campaign.
|
UpdateEmailChannelResult |
updateEmailChannel(UpdateEmailChannelRequest updateEmailChannelRequest)
Enables the email channel for an application or updates the status and settings of the email channel for an
application.
|
UpdateEmailTemplateResult |
updateEmailTemplate(UpdateEmailTemplateRequest updateEmailTemplateRequest)
Updates an existing message template for messages that are sent through the email channel.
|
UpdateEndpointResult |
updateEndpoint(UpdateEndpointRequest updateEndpointRequest)
Creates a new endpoint for an application or updates the settings and attributes of an existing endpoint for an
application.
|
UpdateEndpointsBatchResult |
updateEndpointsBatch(UpdateEndpointsBatchRequest updateEndpointsBatchRequest)
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 updateGcmChannelRequest)
Enables the GCM channel for an application or updates the status and settings of the GCM channel for an
application.
|
UpdateInAppTemplateResult |
updateInAppTemplate(UpdateInAppTemplateRequest updateInAppTemplateRequest)
Updates an existing message template for messages sent through the in-app message channel.
|
UpdateJourneyResult |
updateJourney(UpdateJourneyRequest updateJourneyRequest)
Updates the configuration and other settings for a journey.
|
UpdateJourneyStateResult |
updateJourneyState(UpdateJourneyStateRequest updateJourneyStateRequest)
Cancels (stops) an active journey.
|
UpdatePushTemplateResult |
updatePushTemplate(UpdatePushTemplateRequest updatePushTemplateRequest)
Updates an existing message template for messages that are sent through a push notification channel.
|
UpdateRecommenderConfigurationResult |
updateRecommenderConfiguration(UpdateRecommenderConfigurationRequest updateRecommenderConfigurationRequest)
Updates an Amazon Pinpoint configuration for a recommender model.
|
UpdateSegmentResult |
updateSegment(UpdateSegmentRequest updateSegmentRequest)
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 updateSmsChannelRequest)
Enables the SMS channel for an application or updates the status and settings of the SMS channel for an
application.
|
UpdateSmsTemplateResult |
updateSmsTemplate(UpdateSmsTemplateRequest updateSmsTemplateRequest)
Updates an existing message template for messages that are sent through the SMS channel.
|
UpdateTemplateActiveVersionResult |
updateTemplateActiveVersion(UpdateTemplateActiveVersionRequest updateTemplateActiveVersionRequest)
Changes the status of a specific version of a message template to active.
|
UpdateVoiceChannelResult |
updateVoiceChannel(UpdateVoiceChannelRequest updateVoiceChannelRequest)
Enables the voice channel for an application or updates the status and settings of the voice channel for an
application.
|
UpdateVoiceTemplateResult |
updateVoiceTemplate(UpdateVoiceTemplateRequest updateVoiceTemplateRequest)
Updates an existing message template for messages that are sent through the voice channel.
|
VerifyOTPMessageResult |
verifyOTPMessage(VerifyOTPMessageRequest verifyOTPMessageRequest)
Verify an OTP
|
static final String ENDPOINT_PREFIX
@Deprecated void setEndpoint(String endpoint)
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)
for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
Callers can pass in just the endpoint (ex: "pinpoint.us-east-1.amazonaws.com") or a full URL, including the
protocol (ex: "https://pinpoint.us-east-1.amazonaws.com"). If the protocol is not specified here, the default
protocol from this client's ClientConfiguration
will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
endpoint
- The endpoint (ex: "pinpoint.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
"https://pinpoint.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will
communicate with.@Deprecated void setRegion(Region region)
AwsClientBuilder#setRegion(String)
setEndpoint(String)
, sets the regional endpoint for this client's
service calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
region
- The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,
Region.isServiceSupported(String)
CreateAppResult createApp(CreateAppRequest createAppRequest)
Creates an application.
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).CreateCampaignResult createCampaign(CreateCampaignRequest createCampaignRequest)
Creates a new campaign for an application or updates the settings of an existing campaign for an application.
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).CreateEmailTemplateResult createEmailTemplate(CreateEmailTemplateRequest createEmailTemplateRequest)
Creates a message template for messages that are sent through the email channel.
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).CreateExportJobResult createExportJob(CreateExportJobRequest createExportJobRequest)
Creates an export job for an application.
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).CreateImportJobResult createImportJob(CreateImportJobRequest createImportJobRequest)
Creates an import job for an application.
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).CreateInAppTemplateResult createInAppTemplate(CreateInAppTemplateRequest createInAppTemplateRequest)
Creates a new message template for messages using the in-app message channel.
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).CreateJourneyResult createJourney(CreateJourneyRequest createJourneyRequest)
Creates a journey for an application.
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).CreatePushTemplateResult createPushTemplate(CreatePushTemplateRequest createPushTemplateRequest)
Creates a message template for messages that are sent through a push notification channel.
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).CreateRecommenderConfigurationResult createRecommenderConfiguration(CreateRecommenderConfigurationRequest createRecommenderConfigurationRequest)
Creates an Amazon Pinpoint configuration for a recommender model.
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).CreateSegmentResult createSegment(CreateSegmentRequest createSegmentRequest)
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.
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).CreateSmsTemplateResult createSmsTemplate(CreateSmsTemplateRequest createSmsTemplateRequest)
Creates a message template for messages that are sent through the SMS channel.
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).CreateVoiceTemplateResult createVoiceTemplate(CreateVoiceTemplateRequest createVoiceTemplateRequest)
Creates a message template for messages that are sent through the voice channel.
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).DeleteAdmChannelResult deleteAdmChannel(DeleteAdmChannelRequest deleteAdmChannelRequest)
Disables the ADM channel for an application and deletes any existing settings for the channel.
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).DeleteApnsChannelResult deleteApnsChannel(DeleteApnsChannelRequest deleteApnsChannelRequest)
Disables the APNs channel for an application and deletes any existing settings for the channel.
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).DeleteApnsSandboxChannelResult deleteApnsSandboxChannel(DeleteApnsSandboxChannelRequest deleteApnsSandboxChannelRequest)
Disables the APNs sandbox channel for an application and deletes any existing settings for the channel.
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).DeleteApnsVoipChannelResult deleteApnsVoipChannel(DeleteApnsVoipChannelRequest deleteApnsVoipChannelRequest)
Disables the APNs VoIP channel for an application and deletes any existing settings for the channel.
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).DeleteApnsVoipSandboxChannelResult deleteApnsVoipSandboxChannel(DeleteApnsVoipSandboxChannelRequest deleteApnsVoipSandboxChannelRequest)
Disables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel.
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).DeleteAppResult deleteApp(DeleteAppRequest deleteAppRequest)
Deletes an application.
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).DeleteBaiduChannelResult deleteBaiduChannel(DeleteBaiduChannelRequest deleteBaiduChannelRequest)
Disables the Baidu channel for an application and deletes any existing settings for the channel.
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).DeleteCampaignResult deleteCampaign(DeleteCampaignRequest deleteCampaignRequest)
Deletes a campaign from an application.
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).DeleteEmailChannelResult deleteEmailChannel(DeleteEmailChannelRequest deleteEmailChannelRequest)
Disables the email channel for an application and deletes any existing settings for the channel.
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).DeleteEmailTemplateResult deleteEmailTemplate(DeleteEmailTemplateRequest deleteEmailTemplateRequest)
Deletes a message template for messages that were sent through the email channel.
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).DeleteEndpointResult deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest)
Deletes an endpoint from an application.
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).DeleteEventStreamResult deleteEventStream(DeleteEventStreamRequest deleteEventStreamRequest)
Deletes the event stream for an application.
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).DeleteGcmChannelResult deleteGcmChannel(DeleteGcmChannelRequest deleteGcmChannelRequest)
Disables the GCM channel for an application and deletes any existing settings for the channel.
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).DeleteInAppTemplateResult deleteInAppTemplate(DeleteInAppTemplateRequest deleteInAppTemplateRequest)
Deletes a message template for messages sent using the in-app message channel.
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).DeleteJourneyResult deleteJourney(DeleteJourneyRequest deleteJourneyRequest)
Deletes a journey from an application.
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).DeletePushTemplateResult deletePushTemplate(DeletePushTemplateRequest deletePushTemplateRequest)
Deletes a message template for messages that were sent through a push notification channel.
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).DeleteRecommenderConfigurationResult deleteRecommenderConfiguration(DeleteRecommenderConfigurationRequest deleteRecommenderConfigurationRequest)
Deletes an Amazon Pinpoint configuration for a recommender model.
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).DeleteSegmentResult deleteSegment(DeleteSegmentRequest deleteSegmentRequest)
Deletes a segment from an application.
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).DeleteSmsChannelResult deleteSmsChannel(DeleteSmsChannelRequest deleteSmsChannelRequest)
Disables the SMS channel for an application and deletes any existing settings for the channel.
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).DeleteSmsTemplateResult deleteSmsTemplate(DeleteSmsTemplateRequest deleteSmsTemplateRequest)
Deletes a message template for messages that were sent through the SMS channel.
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).DeleteUserEndpointsResult deleteUserEndpoints(DeleteUserEndpointsRequest deleteUserEndpointsRequest)
Deletes all the endpoints that are associated with a specific user ID.
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).DeleteVoiceChannelResult deleteVoiceChannel(DeleteVoiceChannelRequest deleteVoiceChannelRequest)
Disables the voice channel for an application and deletes any existing settings for the channel.
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).DeleteVoiceTemplateResult deleteVoiceTemplate(DeleteVoiceTemplateRequest deleteVoiceTemplateRequest)
Deletes a message template for messages that were sent through the voice channel.
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).GetAdmChannelResult getAdmChannel(GetAdmChannelRequest getAdmChannelRequest)
Retrieves information about the status and settings of the ADM channel for an application.
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).GetApnsChannelResult getApnsChannel(GetApnsChannelRequest getApnsChannelRequest)
Retrieves information about the status and settings of the APNs channel for an application.
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).GetApnsSandboxChannelResult getApnsSandboxChannel(GetApnsSandboxChannelRequest getApnsSandboxChannelRequest)
Retrieves information about the status and settings of the APNs sandbox channel for an application.
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).GetApnsVoipChannelResult getApnsVoipChannel(GetApnsVoipChannelRequest getApnsVoipChannelRequest)
Retrieves information about the status and settings of the APNs VoIP channel for an application.
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).GetApnsVoipSandboxChannelResult getApnsVoipSandboxChannel(GetApnsVoipSandboxChannelRequest getApnsVoipSandboxChannelRequest)
Retrieves information about the status and settings of the APNs VoIP sandbox channel for an application.
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).GetAppResult getApp(GetAppRequest getAppRequest)
Retrieves information about an application.
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).GetApplicationDateRangeKpiResult getApplicationDateRangeKpi(GetApplicationDateRangeKpiRequest getApplicationDateRangeKpiRequest)
Retrieves (queries) pre-aggregated data for a standard metric that applies to an application.
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).GetApplicationSettingsResult getApplicationSettings(GetApplicationSettingsRequest getApplicationSettingsRequest)
Retrieves information about the settings for an application.
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).GetAppsResult getApps(GetAppsRequest getAppsRequest)
Retrieves information about all the applications that are associated with your Amazon Pinpoint account.
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).GetBaiduChannelResult getBaiduChannel(GetBaiduChannelRequest getBaiduChannelRequest)
Retrieves information about the status and settings of the Baidu channel for an application.
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).GetCampaignResult getCampaign(GetCampaignRequest getCampaignRequest)
Retrieves information about the status, configuration, and other settings for a campaign.
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).GetCampaignActivitiesResult getCampaignActivities(GetCampaignActivitiesRequest getCampaignActivitiesRequest)
Retrieves information about all the activities for a campaign.
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).GetCampaignDateRangeKpiResult getCampaignDateRangeKpi(GetCampaignDateRangeKpiRequest getCampaignDateRangeKpiRequest)
Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign.
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).GetCampaignVersionResult getCampaignVersion(GetCampaignVersionRequest getCampaignVersionRequest)
Retrieves information about the status, configuration, and other settings for a specific version of a campaign.
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).GetCampaignVersionsResult getCampaignVersions(GetCampaignVersionsRequest getCampaignVersionsRequest)
Retrieves information about the status, configuration, and other settings for all versions of a campaign.
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).GetCampaignsResult getCampaigns(GetCampaignsRequest getCampaignsRequest)
Retrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application.
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).GetChannelsResult getChannels(GetChannelsRequest getChannelsRequest)
Retrieves information about the history and status of each channel for an application.
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).GetEmailChannelResult getEmailChannel(GetEmailChannelRequest getEmailChannelRequest)
Retrieves information about the status and settings of the email channel for an application.
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).GetEmailTemplateResult getEmailTemplate(GetEmailTemplateRequest getEmailTemplateRequest)
Retrieves the content and settings of a message template for messages that are sent through the email channel.
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).GetEndpointResult getEndpoint(GetEndpointRequest getEndpointRequest)
Retrieves information about the settings and attributes of a specific endpoint for an application.
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).GetEventStreamResult getEventStream(GetEventStreamRequest getEventStreamRequest)
Retrieves information about the event stream settings for an application.
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).GetExportJobResult getExportJob(GetExportJobRequest getExportJobRequest)
Retrieves information about the status and settings of a specific export job for an application.
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).GetExportJobsResult getExportJobs(GetExportJobsRequest getExportJobsRequest)
Retrieves information about the status and settings of all the export jobs for an application.
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).GetGcmChannelResult getGcmChannel(GetGcmChannelRequest getGcmChannelRequest)
Retrieves information about the status and settings of the GCM channel for an application.
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).GetImportJobResult getImportJob(GetImportJobRequest getImportJobRequest)
Retrieves information about the status and settings of a specific import job for an application.
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).GetImportJobsResult getImportJobs(GetImportJobsRequest getImportJobsRequest)
Retrieves information about the status and settings of all the import jobs for an application.
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).GetInAppMessagesResult getInAppMessages(GetInAppMessagesRequest getInAppMessagesRequest)
Retrieves the in-app messages targeted for the provided endpoint ID.
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).GetInAppTemplateResult getInAppTemplate(GetInAppTemplateRequest getInAppTemplateRequest)
Retrieves the content and settings of a message template for messages sent through the in-app channel.
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).GetJourneyResult getJourney(GetJourneyRequest getJourneyRequest)
Retrieves information about the status, configuration, and other settings for a journey.
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).GetJourneyDateRangeKpiResult getJourneyDateRangeKpi(GetJourneyDateRangeKpiRequest getJourneyDateRangeKpiRequest)
Retrieves (queries) pre-aggregated data for a standard engagement metric that applies to a journey.
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).GetJourneyExecutionActivityMetricsResult getJourneyExecutionActivityMetrics(GetJourneyExecutionActivityMetricsRequest getJourneyExecutionActivityMetricsRequest)
Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey activity.
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).GetJourneyExecutionMetricsResult getJourneyExecutionMetrics(GetJourneyExecutionMetricsRequest getJourneyExecutionMetricsRequest)
Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey.
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).GetJourneyRunExecutionActivityMetricsResult getJourneyRunExecutionActivityMetrics(GetJourneyRunExecutionActivityMetricsRequest getJourneyRunExecutionActivityMetricsRequest)
Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey activity.
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).GetJourneyRunExecutionMetricsResult getJourneyRunExecutionMetrics(GetJourneyRunExecutionMetricsRequest getJourneyRunExecutionMetricsRequest)
Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey.
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).GetJourneyRunsResult getJourneyRuns(GetJourneyRunsRequest getJourneyRunsRequest)
Provides information about the runs of a journey.
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).GetPushTemplateResult getPushTemplate(GetPushTemplateRequest getPushTemplateRequest)
Retrieves the content and settings of a message template for messages that are sent through a push notification channel.
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).GetRecommenderConfigurationResult getRecommenderConfiguration(GetRecommenderConfigurationRequest getRecommenderConfigurationRequest)
Retrieves information about an Amazon Pinpoint configuration for a recommender model.
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).GetRecommenderConfigurationsResult getRecommenderConfigurations(GetRecommenderConfigurationsRequest getRecommenderConfigurationsRequest)
Retrieves information about all the recommender model configurations that are associated with your Amazon Pinpoint account.
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).GetSegmentResult getSegment(GetSegmentRequest getSegmentRequest)
Retrieves information about the configuration, dimension, and other settings for a specific segment that's associated with an application.
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).GetSegmentExportJobsResult getSegmentExportJobs(GetSegmentExportJobsRequest getSegmentExportJobsRequest)
Retrieves information about the status and settings of the export jobs for a segment.
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).GetSegmentImportJobsResult getSegmentImportJobs(GetSegmentImportJobsRequest getSegmentImportJobsRequest)
Retrieves information about the status and settings of the import jobs for a segment.
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).GetSegmentVersionResult getSegmentVersion(GetSegmentVersionRequest getSegmentVersionRequest)
Retrieves information about the configuration, dimension, and other settings for a specific version of a segment that's associated with an application.
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).GetSegmentVersionsResult getSegmentVersions(GetSegmentVersionsRequest getSegmentVersionsRequest)
Retrieves information about the configuration, dimension, and other settings for all the versions of a specific segment that's associated with an application.
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).GetSegmentsResult getSegments(GetSegmentsRequest getSegmentsRequest)
Retrieves information about the configuration, dimension, and other settings for all the segments that are associated with an application.
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).GetSmsChannelResult getSmsChannel(GetSmsChannelRequest getSmsChannelRequest)
Retrieves information about the status and settings of the SMS channel for an application.
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).GetSmsTemplateResult getSmsTemplate(GetSmsTemplateRequest getSmsTemplateRequest)
Retrieves the content and settings of a message template for messages that are sent through the SMS channel.
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).GetUserEndpointsResult getUserEndpoints(GetUserEndpointsRequest getUserEndpointsRequest)
Retrieves information about all the endpoints that are associated with a specific user ID.
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).GetVoiceChannelResult getVoiceChannel(GetVoiceChannelRequest getVoiceChannelRequest)
Retrieves information about the status and settings of the voice channel for an application.
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).GetVoiceTemplateResult getVoiceTemplate(GetVoiceTemplateRequest getVoiceTemplateRequest)
Retrieves the content and settings of a message template for messages that are sent through the voice channel.
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).ListJourneysResult listJourneys(ListJourneysRequest listJourneysRequest)
Retrieves information about the status, configuration, and other settings for all the journeys that are associated with an application.
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).ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Retrieves all the tags (keys and values) that are associated with an application, campaign, message template, or segment.
listTagsForResourceRequest
- ListTemplateVersionsResult listTemplateVersions(ListTemplateVersionsRequest listTemplateVersionsRequest)
Retrieves information about all the versions of a specific message template.
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).ListTemplatesResult listTemplates(ListTemplatesRequest listTemplatesRequest)
Retrieves information about all the message templates that are associated with your Amazon Pinpoint account.
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).PhoneNumberValidateResult phoneNumberValidate(PhoneNumberValidateRequest phoneNumberValidateRequest)
Retrieves information about a phone number.
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).PutEventStreamResult putEventStream(PutEventStreamRequest putEventStreamRequest)
Creates a new event stream for an application or updates the settings of an existing event stream for an application.
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).PutEventsResult putEvents(PutEventsRequest putEventsRequest)
Creates a new event to record for endpoints, or creates or updates endpoint data that existing events are associated with.
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).RemoveAttributesResult removeAttributes(RemoveAttributesRequest removeAttributesRequest)
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.
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).SendMessagesResult sendMessages(SendMessagesRequest sendMessagesRequest)
Creates and sends a direct message.
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).SendOTPMessageResult sendOTPMessage(SendOTPMessageRequest sendOTPMessageRequest)
Send an OTP message
sendOTPMessageRequest
- BadRequestException
- 400 responseInternalServerErrorException
- 500 responsePayloadTooLargeException
- 413 responseForbiddenException
- 403 responseNotFoundException
- 404 responseMethodNotAllowedException
- 405 responseTooManyRequestsException
- 429 responseSendUsersMessagesResult sendUsersMessages(SendUsersMessagesRequest sendUsersMessagesRequest)
Creates and sends a message to a list of users.
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).TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Adds one or more tags (keys and values) to an application, campaign, message template, or segment.
tagResourceRequest
- UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes one or more tags (keys and values) from an application, campaign, message template, or segment.
untagResourceRequest
- UpdateAdmChannelResult updateAdmChannel(UpdateAdmChannelRequest updateAdmChannelRequest)
Enables the ADM channel for an application or updates the status and settings of the ADM channel for an application.
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).UpdateApnsChannelResult updateApnsChannel(UpdateApnsChannelRequest updateApnsChannelRequest)
Enables the APNs channel for an application or updates the status and settings of the APNs channel for an application.
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).UpdateApnsSandboxChannelResult updateApnsSandboxChannel(UpdateApnsSandboxChannelRequest updateApnsSandboxChannelRequest)
Enables the APNs sandbox channel for an application or updates the status and settings of the APNs sandbox channel for an application.
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).UpdateApnsVoipChannelResult updateApnsVoipChannel(UpdateApnsVoipChannelRequest updateApnsVoipChannelRequest)
Enables the APNs VoIP channel for an application or updates the status and settings of the APNs VoIP channel for an application.
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).UpdateApnsVoipSandboxChannelResult updateApnsVoipSandboxChannel(UpdateApnsVoipSandboxChannelRequest updateApnsVoipSandboxChannelRequest)
Enables the APNs VoIP sandbox channel for an application or updates the status and settings of the APNs VoIP sandbox channel for an application.
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).UpdateApplicationSettingsResult updateApplicationSettings(UpdateApplicationSettingsRequest updateApplicationSettingsRequest)
Updates the settings for an application.
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).UpdateBaiduChannelResult updateBaiduChannel(UpdateBaiduChannelRequest updateBaiduChannelRequest)
Enables the Baidu channel for an application or updates the status and settings of the Baidu channel for an application.
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).UpdateCampaignResult updateCampaign(UpdateCampaignRequest updateCampaignRequest)
Updates the configuration and other settings for a campaign.
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).UpdateEmailChannelResult updateEmailChannel(UpdateEmailChannelRequest updateEmailChannelRequest)
Enables the email channel for an application or updates the status and settings of the email channel for an application.
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).UpdateEmailTemplateResult updateEmailTemplate(UpdateEmailTemplateRequest updateEmailTemplateRequest)
Updates an existing message template for messages that are sent through the email channel.
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).UpdateEndpointResult updateEndpoint(UpdateEndpointRequest updateEndpointRequest)
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.
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).UpdateEndpointsBatchResult updateEndpointsBatch(UpdateEndpointsBatchRequest updateEndpointsBatchRequest)
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.
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).UpdateGcmChannelResult updateGcmChannel(UpdateGcmChannelRequest updateGcmChannelRequest)
Enables the GCM channel for an application or updates the status and settings of the GCM channel for an application.
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).UpdateInAppTemplateResult updateInAppTemplate(UpdateInAppTemplateRequest updateInAppTemplateRequest)
Updates an existing message template for messages sent through the in-app message channel.
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).UpdateJourneyResult updateJourney(UpdateJourneyRequest updateJourneyRequest)
Updates the configuration and other settings for a journey.
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).UpdateJourneyStateResult updateJourneyState(UpdateJourneyStateRequest updateJourneyStateRequest)
Cancels (stops) an active journey.
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).UpdatePushTemplateResult updatePushTemplate(UpdatePushTemplateRequest updatePushTemplateRequest)
Updates an existing message template for messages that are sent through a push notification channel.
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).UpdateRecommenderConfigurationResult updateRecommenderConfiguration(UpdateRecommenderConfigurationRequest updateRecommenderConfigurationRequest)
Updates an Amazon Pinpoint configuration for a recommender model.
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).UpdateSegmentResult updateSegment(UpdateSegmentRequest updateSegmentRequest)
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.
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).UpdateSmsChannelResult updateSmsChannel(UpdateSmsChannelRequest updateSmsChannelRequest)
Enables the SMS channel for an application or updates the status and settings of the SMS channel for an application.
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).UpdateSmsTemplateResult updateSmsTemplate(UpdateSmsTemplateRequest updateSmsTemplateRequest)
Updates an existing message template for messages that are sent through the SMS channel.
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).UpdateTemplateActiveVersionResult updateTemplateActiveVersion(UpdateTemplateActiveVersionRequest updateTemplateActiveVersionRequest)
Changes the status of a specific version of a message template to active.
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).UpdateVoiceChannelResult updateVoiceChannel(UpdateVoiceChannelRequest updateVoiceChannelRequest)
Enables the voice channel for an application or updates the status and settings of the voice channel for an application.
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).UpdateVoiceTemplateResult updateVoiceTemplate(UpdateVoiceTemplateRequest updateVoiceTemplateRequest)
Updates an existing message template for messages that are sent through the voice channel.
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).VerifyOTPMessageResult verifyOTPMessage(VerifyOTPMessageRequest verifyOTPMessageRequest)
Verify an OTP
verifyOTPMessageRequest
- BadRequestException
- 400 responseInternalServerErrorException
- 500 responsePayloadTooLargeException
- 413 responseForbiddenException
- 403 responseNotFoundException
- 404 responseMethodNotAllowedException
- 405 responseTooManyRequestsException
- 429 responsevoid shutdown()
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 a request.
request
- The originally executed request.