/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.pinpoint; import javax.annotation.Generated; import com.amazonaws.*; import com.amazonaws.regions.*; import com.amazonaws.services.pinpoint.model.*; /** * Interface for accessing Amazon Pinpoint. *

* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.pinpoint.AbstractAmazonPinpoint} instead. *

*

*

* Doc Engage API - Amazon Pinpoint API *

*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AmazonPinpoint { /** * The region metadata service name for computing region endpoints. You can use this value to retrieve metadata * (such as supported regions) of the service. * * @see RegionUtils#getRegionsForService(String) */ String ENDPOINT_PREFIX = "pinpoint"; /** * Overrides the default endpoint for this client ("https://pinpoint.us-east-1.amazonaws.com"). Callers can use this * method to control which AWS region they want to work with. *

* 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 {@link 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. * * @param 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 use {@link AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)} for * example: * {@code builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));} */ @Deprecated void setEndpoint(String endpoint); /** * An alternative to {@link AmazonPinpoint#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 * {@link 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. * * @param region * The region this client will communicate with. See {@link 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. * * @see Region#getRegion(com.amazonaws.regions.Regions) * @see Region#createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration) * @see Region#isServiceSupported(String) * @deprecated use {@link AwsClientBuilder#setRegion(String)} */ @Deprecated void setRegion(Region region); /** *

* Creates an application. *

* * @param createAppRequest * @return Result of the CreateApp operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.CreateApp * @see AWS API * Documentation */ CreateAppResult createApp(CreateAppRequest createAppRequest); /** *

* Creates a new campaign for an application or updates the settings of an existing campaign for an application. *

* * @param createCampaignRequest * @return Result of the CreateCampaign operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.CreateCampaign * @see AWS API * Documentation */ CreateCampaignResult createCampaign(CreateCampaignRequest createCampaignRequest); /** *

* Creates a message template for messages that are sent through the email channel. *

* * @param createEmailTemplateRequest * @return Result of the CreateEmailTemplate operation returned by the service. * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @sample AmazonPinpoint.CreateEmailTemplate * @see AWS * API Documentation */ CreateEmailTemplateResult createEmailTemplate(CreateEmailTemplateRequest createEmailTemplateRequest); /** *

* Creates an export job for an application. *

* * @param createExportJobRequest * @return Result of the CreateExportJob operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.CreateExportJob * @see AWS API * Documentation */ CreateExportJobResult createExportJob(CreateExportJobRequest createExportJobRequest); /** *

* Creates an import job for an application. *

* * @param createImportJobRequest * @return Result of the CreateImportJob operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.CreateImportJob * @see AWS API * Documentation */ CreateImportJobResult createImportJob(CreateImportJobRequest createImportJobRequest); /** *

* Creates a new message template for messages using the in-app message channel. *

* * @param createInAppTemplateRequest * @return Result of the CreateInAppTemplate operation returned by the service. * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @sample AmazonPinpoint.CreateInAppTemplate * @see AWS * API Documentation */ CreateInAppTemplateResult createInAppTemplate(CreateInAppTemplateRequest createInAppTemplateRequest); /** *

* Creates a journey for an application. *

* * @param createJourneyRequest * @return Result of the CreateJourney operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.CreateJourney * @see AWS API * Documentation */ CreateJourneyResult createJourney(CreateJourneyRequest createJourneyRequest); /** *

* Creates a message template for messages that are sent through a push notification channel. *

* * @param createPushTemplateRequest * @return Result of the CreatePushTemplate operation returned by the service. * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @sample AmazonPinpoint.CreatePushTemplate * @see AWS * API Documentation */ CreatePushTemplateResult createPushTemplate(CreatePushTemplateRequest createPushTemplateRequest); /** *

* Creates an Amazon Pinpoint configuration for a recommender model. *

* * @param createRecommenderConfigurationRequest * @return Result of the CreateRecommenderConfiguration operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.CreateRecommenderConfiguration * @see AWS API Documentation */ CreateRecommenderConfigurationResult createRecommenderConfiguration(CreateRecommenderConfigurationRequest createRecommenderConfigurationRequest); /** *

* 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. *

* * @param createSegmentRequest * @return Result of the CreateSegment operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.CreateSegment * @see AWS API * Documentation */ CreateSegmentResult createSegment(CreateSegmentRequest createSegmentRequest); /** *

* Creates a message template for messages that are sent through the SMS channel. *

* * @param createSmsTemplateRequest * @return Result of the CreateSmsTemplate operation returned by the service. * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @sample AmazonPinpoint.CreateSmsTemplate * @see AWS API * Documentation */ CreateSmsTemplateResult createSmsTemplate(CreateSmsTemplateRequest createSmsTemplateRequest); /** *

* Creates a message template for messages that are sent through the voice channel. *

* * @param createVoiceTemplateRequest * @return Result of the CreateVoiceTemplate operation returned by the service. * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @sample AmazonPinpoint.CreateVoiceTemplate * @see AWS * API Documentation */ CreateVoiceTemplateResult createVoiceTemplate(CreateVoiceTemplateRequest createVoiceTemplateRequest); /** *

* Disables the ADM channel for an application and deletes any existing settings for the channel. *

* * @param deleteAdmChannelRequest * @return Result of the DeleteAdmChannel operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.DeleteAdmChannel * @see AWS API * Documentation */ DeleteAdmChannelResult deleteAdmChannel(DeleteAdmChannelRequest deleteAdmChannelRequest); /** *

* Disables the APNs channel for an application and deletes any existing settings for the channel. *

* * @param deleteApnsChannelRequest * @return Result of the DeleteApnsChannel operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.DeleteApnsChannel * @see AWS API * Documentation */ DeleteApnsChannelResult deleteApnsChannel(DeleteApnsChannelRequest deleteApnsChannelRequest); /** *

* Disables the APNs sandbox channel for an application and deletes any existing settings for the channel. *

* * @param deleteApnsSandboxChannelRequest * @return Result of the DeleteApnsSandboxChannel operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.DeleteApnsSandboxChannel * @see AWS API Documentation */ DeleteApnsSandboxChannelResult deleteApnsSandboxChannel(DeleteApnsSandboxChannelRequest deleteApnsSandboxChannelRequest); /** *

* Disables the APNs VoIP channel for an application and deletes any existing settings for the channel. *

* * @param deleteApnsVoipChannelRequest * @return Result of the DeleteApnsVoipChannel operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.DeleteApnsVoipChannel * @see AWS * API Documentation */ DeleteApnsVoipChannelResult deleteApnsVoipChannel(DeleteApnsVoipChannelRequest deleteApnsVoipChannelRequest); /** *

* Disables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel. *

* * @param deleteApnsVoipSandboxChannelRequest * @return Result of the DeleteApnsVoipSandboxChannel operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.DeleteApnsVoipSandboxChannel * @see AWS API Documentation */ DeleteApnsVoipSandboxChannelResult deleteApnsVoipSandboxChannel(DeleteApnsVoipSandboxChannelRequest deleteApnsVoipSandboxChannelRequest); /** *

* Deletes an application. *

* * @param deleteAppRequest * @return Result of the DeleteApp operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.DeleteApp * @see AWS API * Documentation */ DeleteAppResult deleteApp(DeleteAppRequest deleteAppRequest); /** *

* Disables the Baidu channel for an application and deletes any existing settings for the channel. *

* * @param deleteBaiduChannelRequest * @return Result of the DeleteBaiduChannel operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.DeleteBaiduChannel * @see AWS * API Documentation */ DeleteBaiduChannelResult deleteBaiduChannel(DeleteBaiduChannelRequest deleteBaiduChannelRequest); /** *

* Deletes a campaign from an application. *

* * @param deleteCampaignRequest * @return Result of the DeleteCampaign operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.DeleteCampaign * @see AWS API * Documentation */ DeleteCampaignResult deleteCampaign(DeleteCampaignRequest deleteCampaignRequest); /** *

* Disables the email channel for an application and deletes any existing settings for the channel. *

* * @param deleteEmailChannelRequest * @return Result of the DeleteEmailChannel operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.DeleteEmailChannel * @see AWS * API Documentation */ DeleteEmailChannelResult deleteEmailChannel(DeleteEmailChannelRequest deleteEmailChannelRequest); /** *

* Deletes a message template for messages that were sent through the email channel. *

* * @param deleteEmailTemplateRequest * @return Result of the DeleteEmailTemplate operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.DeleteEmailTemplate * @see AWS * API Documentation */ DeleteEmailTemplateResult deleteEmailTemplate(DeleteEmailTemplateRequest deleteEmailTemplateRequest); /** *

* Deletes an endpoint from an application. *

* * @param deleteEndpointRequest * @return Result of the DeleteEndpoint operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.DeleteEndpoint * @see AWS API * Documentation */ DeleteEndpointResult deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest); /** *

* Deletes the event stream for an application. *

* * @param deleteEventStreamRequest * @return Result of the DeleteEventStream operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.DeleteEventStream * @see AWS API * Documentation */ DeleteEventStreamResult deleteEventStream(DeleteEventStreamRequest deleteEventStreamRequest); /** *

* Disables the GCM channel for an application and deletes any existing settings for the channel. *

* * @param deleteGcmChannelRequest * @return Result of the DeleteGcmChannel operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.DeleteGcmChannel * @see AWS API * Documentation */ DeleteGcmChannelResult deleteGcmChannel(DeleteGcmChannelRequest deleteGcmChannelRequest); /** *

* Deletes a message template for messages sent using the in-app message channel. *

* * @param deleteInAppTemplateRequest * @return Result of the DeleteInAppTemplate operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.DeleteInAppTemplate * @see AWS * API Documentation */ DeleteInAppTemplateResult deleteInAppTemplate(DeleteInAppTemplateRequest deleteInAppTemplateRequest); /** *

* Deletes a journey from an application. *

* * @param deleteJourneyRequest * @return Result of the DeleteJourney operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.DeleteJourney * @see AWS API * Documentation */ DeleteJourneyResult deleteJourney(DeleteJourneyRequest deleteJourneyRequest); /** *

* Deletes a message template for messages that were sent through a push notification channel. *

* * @param deletePushTemplateRequest * @return Result of the DeletePushTemplate operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.DeletePushTemplate * @see AWS * API Documentation */ DeletePushTemplateResult deletePushTemplate(DeletePushTemplateRequest deletePushTemplateRequest); /** *

* Deletes an Amazon Pinpoint configuration for a recommender model. *

* * @param deleteRecommenderConfigurationRequest * @return Result of the DeleteRecommenderConfiguration operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.DeleteRecommenderConfiguration * @see AWS API Documentation */ DeleteRecommenderConfigurationResult deleteRecommenderConfiguration(DeleteRecommenderConfigurationRequest deleteRecommenderConfigurationRequest); /** *

* Deletes a segment from an application. *

* * @param deleteSegmentRequest * @return Result of the DeleteSegment operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.DeleteSegment * @see AWS API * Documentation */ DeleteSegmentResult deleteSegment(DeleteSegmentRequest deleteSegmentRequest); /** *

* Disables the SMS channel for an application and deletes any existing settings for the channel. *

* * @param deleteSmsChannelRequest * @return Result of the DeleteSmsChannel operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.DeleteSmsChannel * @see AWS API * Documentation */ DeleteSmsChannelResult deleteSmsChannel(DeleteSmsChannelRequest deleteSmsChannelRequest); /** *

* Deletes a message template for messages that were sent through the SMS channel. *

* * @param deleteSmsTemplateRequest * @return Result of the DeleteSmsTemplate operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.DeleteSmsTemplate * @see AWS API * Documentation */ DeleteSmsTemplateResult deleteSmsTemplate(DeleteSmsTemplateRequest deleteSmsTemplateRequest); /** *

* Deletes all the endpoints that are associated with a specific user ID. *

* * @param deleteUserEndpointsRequest * @return Result of the DeleteUserEndpoints operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.DeleteUserEndpoints * @see AWS * API Documentation */ DeleteUserEndpointsResult deleteUserEndpoints(DeleteUserEndpointsRequest deleteUserEndpointsRequest); /** *

* Disables the voice channel for an application and deletes any existing settings for the channel. *

* * @param deleteVoiceChannelRequest * @return Result of the DeleteVoiceChannel operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.DeleteVoiceChannel * @see AWS * API Documentation */ DeleteVoiceChannelResult deleteVoiceChannel(DeleteVoiceChannelRequest deleteVoiceChannelRequest); /** *

* Deletes a message template for messages that were sent through the voice channel. *

* * @param deleteVoiceTemplateRequest * @return Result of the DeleteVoiceTemplate operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.DeleteVoiceTemplate * @see AWS * API Documentation */ DeleteVoiceTemplateResult deleteVoiceTemplate(DeleteVoiceTemplateRequest deleteVoiceTemplateRequest); /** *

* Retrieves information about the status and settings of the ADM channel for an application. *

* * @param getAdmChannelRequest * @return Result of the GetAdmChannel operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.GetAdmChannel * @see AWS API * Documentation */ GetAdmChannelResult getAdmChannel(GetAdmChannelRequest getAdmChannelRequest); /** *

* Retrieves information about the status and settings of the APNs channel for an application. *

* * @param getApnsChannelRequest * @return Result of the GetApnsChannel operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.GetApnsChannel * @see AWS API * Documentation */ GetApnsChannelResult getApnsChannel(GetApnsChannelRequest getApnsChannelRequest); /** *

* Retrieves information about the status and settings of the APNs sandbox channel for an application. *

* * @param getApnsSandboxChannelRequest * @return Result of the GetApnsSandboxChannel operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.GetApnsSandboxChannel * @see AWS * API Documentation */ GetApnsSandboxChannelResult getApnsSandboxChannel(GetApnsSandboxChannelRequest getApnsSandboxChannelRequest); /** *

* Retrieves information about the status and settings of the APNs VoIP channel for an application. *

* * @param getApnsVoipChannelRequest * @return Result of the GetApnsVoipChannel operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.GetApnsVoipChannel * @see AWS * API Documentation */ GetApnsVoipChannelResult getApnsVoipChannel(GetApnsVoipChannelRequest getApnsVoipChannelRequest); /** *

* Retrieves information about the status and settings of the APNs VoIP sandbox channel for an application. *

* * @param getApnsVoipSandboxChannelRequest * @return Result of the GetApnsVoipSandboxChannel operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.GetApnsVoipSandboxChannel * @see AWS API Documentation */ GetApnsVoipSandboxChannelResult getApnsVoipSandboxChannel(GetApnsVoipSandboxChannelRequest getApnsVoipSandboxChannelRequest); /** *

* Retrieves information about an application. *

* * @param getAppRequest * @return Result of the GetApp operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.GetApp * @see AWS API * Documentation */ GetAppResult getApp(GetAppRequest getAppRequest); /** *

* Retrieves (queries) pre-aggregated data for a standard metric that applies to an application. *

* * @param getApplicationDateRangeKpiRequest * @return Result of the GetApplicationDateRangeKpi operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.GetApplicationDateRangeKpi * @see AWS API Documentation */ GetApplicationDateRangeKpiResult getApplicationDateRangeKpi(GetApplicationDateRangeKpiRequest getApplicationDateRangeKpiRequest); /** *

* Retrieves information about the settings for an application. *

* * @param getApplicationSettingsRequest * @return Result of the GetApplicationSettings operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.GetApplicationSettings * @see AWS API Documentation */ GetApplicationSettingsResult getApplicationSettings(GetApplicationSettingsRequest getApplicationSettingsRequest); /** *

* Retrieves information about all the applications that are associated with your Amazon Pinpoint account. *

* * @param getAppsRequest * @return Result of the GetApps operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.GetApps * @see AWS API * Documentation */ GetAppsResult getApps(GetAppsRequest getAppsRequest); /** *

* Retrieves information about the status and settings of the Baidu channel for an application. *

* * @param getBaiduChannelRequest * @return Result of the GetBaiduChannel operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.GetBaiduChannel * @see AWS API * Documentation */ GetBaiduChannelResult getBaiduChannel(GetBaiduChannelRequest getBaiduChannelRequest); /** *

* Retrieves information about the status, configuration, and other settings for a campaign. *

* * @param getCampaignRequest * @return Result of the GetCampaign operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.GetCampaign * @see AWS API * Documentation */ GetCampaignResult getCampaign(GetCampaignRequest getCampaignRequest); /** *

* Retrieves information about all the activities for a campaign. *

* * @param getCampaignActivitiesRequest * @return Result of the GetCampaignActivities operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.GetCampaignActivities * @see AWS * API Documentation */ GetCampaignActivitiesResult getCampaignActivities(GetCampaignActivitiesRequest getCampaignActivitiesRequest); /** *

* Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign. *

* * @param getCampaignDateRangeKpiRequest * @return Result of the GetCampaignDateRangeKpi operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.GetCampaignDateRangeKpi * @see AWS API Documentation */ GetCampaignDateRangeKpiResult getCampaignDateRangeKpi(GetCampaignDateRangeKpiRequest getCampaignDateRangeKpiRequest); /** *

* Retrieves information about the status, configuration, and other settings for a specific version of a campaign. *

* * @param getCampaignVersionRequest * @return Result of the GetCampaignVersion operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.GetCampaignVersion * @see AWS * API Documentation */ GetCampaignVersionResult getCampaignVersion(GetCampaignVersionRequest getCampaignVersionRequest); /** *

* Retrieves information about the status, configuration, and other settings for all versions of a campaign. *

* * @param getCampaignVersionsRequest * @return Result of the GetCampaignVersions operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.GetCampaignVersions * @see AWS * API Documentation */ GetCampaignVersionsResult getCampaignVersions(GetCampaignVersionsRequest getCampaignVersionsRequest); /** *

* Retrieves information about the status, configuration, and other settings for all the campaigns that are * associated with an application. *

* * @param getCampaignsRequest * @return Result of the GetCampaigns operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.GetCampaigns * @see AWS API * Documentation */ GetCampaignsResult getCampaigns(GetCampaignsRequest getCampaignsRequest); /** *

* Retrieves information about the history and status of each channel for an application. *

* * @param getChannelsRequest * @return Result of the GetChannels operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.GetChannels * @see AWS API * Documentation */ GetChannelsResult getChannels(GetChannelsRequest getChannelsRequest); /** *

* Retrieves information about the status and settings of the email channel for an application. *

* * @param getEmailChannelRequest * @return Result of the GetEmailChannel operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.GetEmailChannel * @see AWS API * Documentation */ GetEmailChannelResult getEmailChannel(GetEmailChannelRequest getEmailChannelRequest); /** *

* Retrieves the content and settings of a message template for messages that are sent through the email channel. *

* * @param getEmailTemplateRequest * @return Result of the GetEmailTemplate operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.GetEmailTemplate * @see AWS API * Documentation */ GetEmailTemplateResult getEmailTemplate(GetEmailTemplateRequest getEmailTemplateRequest); /** *

* Retrieves information about the settings and attributes of a specific endpoint for an application. *

* * @param getEndpointRequest * @return Result of the GetEndpoint operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.GetEndpoint * @see AWS API * Documentation */ GetEndpointResult getEndpoint(GetEndpointRequest getEndpointRequest); /** *

* Retrieves information about the event stream settings for an application. *

* * @param getEventStreamRequest * @return Result of the GetEventStream operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.GetEventStream * @see AWS API * Documentation */ GetEventStreamResult getEventStream(GetEventStreamRequest getEventStreamRequest); /** *

* Retrieves information about the status and settings of a specific export job for an application. *

* * @param getExportJobRequest * @return Result of the GetExportJob operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.GetExportJob * @see AWS API * Documentation */ GetExportJobResult getExportJob(GetExportJobRequest getExportJobRequest); /** *

* Retrieves information about the status and settings of all the export jobs for an application. *

* * @param getExportJobsRequest * @return Result of the GetExportJobs operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.GetExportJobs * @see AWS API * Documentation */ GetExportJobsResult getExportJobs(GetExportJobsRequest getExportJobsRequest); /** *

* Retrieves information about the status and settings of the GCM channel for an application. *

* * @param getGcmChannelRequest * @return Result of the GetGcmChannel operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.GetGcmChannel * @see AWS API * Documentation */ GetGcmChannelResult getGcmChannel(GetGcmChannelRequest getGcmChannelRequest); /** *

* Retrieves information about the status and settings of a specific import job for an application. *

* * @param getImportJobRequest * @return Result of the GetImportJob operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.GetImportJob * @see AWS API * Documentation */ GetImportJobResult getImportJob(GetImportJobRequest getImportJobRequest); /** *

* Retrieves information about the status and settings of all the import jobs for an application. *

* * @param getImportJobsRequest * @return Result of the GetImportJobs operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.GetImportJobs * @see AWS API * Documentation */ GetImportJobsResult getImportJobs(GetImportJobsRequest getImportJobsRequest); /** *

* Retrieves the in-app messages targeted for the provided endpoint ID. *

* * @param getInAppMessagesRequest * @return Result of the GetInAppMessages operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.GetInAppMessages * @see AWS API * Documentation */ GetInAppMessagesResult getInAppMessages(GetInAppMessagesRequest getInAppMessagesRequest); /** *

* Retrieves the content and settings of a message template for messages sent through the in-app channel. *

* * @param getInAppTemplateRequest * @return Result of the GetInAppTemplate operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.GetInAppTemplate * @see AWS API * Documentation */ GetInAppTemplateResult getInAppTemplate(GetInAppTemplateRequest getInAppTemplateRequest); /** *

* Retrieves information about the status, configuration, and other settings for a journey. *

* * @param getJourneyRequest * @return Result of the GetJourney operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.GetJourney * @see AWS API * Documentation */ GetJourneyResult getJourney(GetJourneyRequest getJourneyRequest); /** *

* Retrieves (queries) pre-aggregated data for a standard engagement metric that applies to a journey. *

* * @param getJourneyDateRangeKpiRequest * @return Result of the GetJourneyDateRangeKpi operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.GetJourneyDateRangeKpi * @see AWS API Documentation */ GetJourneyDateRangeKpiResult getJourneyDateRangeKpi(GetJourneyDateRangeKpiRequest getJourneyDateRangeKpiRequest); /** *

* Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey activity. *

* * @param getJourneyExecutionActivityMetricsRequest * @return Result of the GetJourneyExecutionActivityMetrics operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.GetJourneyExecutionActivityMetrics * @see AWS API Documentation */ GetJourneyExecutionActivityMetricsResult getJourneyExecutionActivityMetrics( GetJourneyExecutionActivityMetricsRequest getJourneyExecutionActivityMetricsRequest); /** *

* Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey. *

* * @param getJourneyExecutionMetricsRequest * @return Result of the GetJourneyExecutionMetrics operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.GetJourneyExecutionMetrics * @see AWS API Documentation */ GetJourneyExecutionMetricsResult getJourneyExecutionMetrics(GetJourneyExecutionMetricsRequest getJourneyExecutionMetricsRequest); /** *

* Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey activity. *

* * @param getJourneyRunExecutionActivityMetricsRequest * @return Result of the GetJourneyRunExecutionActivityMetrics operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.GetJourneyRunExecutionActivityMetrics * @see AWS API Documentation */ GetJourneyRunExecutionActivityMetricsResult getJourneyRunExecutionActivityMetrics( GetJourneyRunExecutionActivityMetricsRequest getJourneyRunExecutionActivityMetricsRequest); /** *

* Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey. *

* * @param getJourneyRunExecutionMetricsRequest * @return Result of the GetJourneyRunExecutionMetrics operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.GetJourneyRunExecutionMetrics * @see AWS API Documentation */ GetJourneyRunExecutionMetricsResult getJourneyRunExecutionMetrics(GetJourneyRunExecutionMetricsRequest getJourneyRunExecutionMetricsRequest); /** *

* Provides information about the runs of a journey. *

* * @param getJourneyRunsRequest * @return Result of the GetJourneyRuns operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.GetJourneyRuns * @see AWS API * Documentation */ GetJourneyRunsResult getJourneyRuns(GetJourneyRunsRequest getJourneyRunsRequest); /** *

* Retrieves the content and settings of a message template for messages that are sent through a push notification * channel. *

* * @param getPushTemplateRequest * @return Result of the GetPushTemplate operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.GetPushTemplate * @see AWS API * Documentation */ GetPushTemplateResult getPushTemplate(GetPushTemplateRequest getPushTemplateRequest); /** *

* Retrieves information about an Amazon Pinpoint configuration for a recommender model. *

* * @param getRecommenderConfigurationRequest * @return Result of the GetRecommenderConfiguration operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.GetRecommenderConfiguration * @see AWS API Documentation */ GetRecommenderConfigurationResult getRecommenderConfiguration(GetRecommenderConfigurationRequest getRecommenderConfigurationRequest); /** *

* Retrieves information about all the recommender model configurations that are associated with your Amazon * Pinpoint account. *

* * @param getRecommenderConfigurationsRequest * @return Result of the GetRecommenderConfigurations operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.GetRecommenderConfigurations * @see AWS API Documentation */ GetRecommenderConfigurationsResult getRecommenderConfigurations(GetRecommenderConfigurationsRequest getRecommenderConfigurationsRequest); /** *

* Retrieves information about the configuration, dimension, and other settings for a specific segment that's * associated with an application. *

* * @param getSegmentRequest * @return Result of the GetSegment operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.GetSegment * @see AWS API * Documentation */ GetSegmentResult getSegment(GetSegmentRequest getSegmentRequest); /** *

* Retrieves information about the status and settings of the export jobs for a segment. *

* * @param getSegmentExportJobsRequest * @return Result of the GetSegmentExportJobs operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.GetSegmentExportJobs * @see AWS * API Documentation */ GetSegmentExportJobsResult getSegmentExportJobs(GetSegmentExportJobsRequest getSegmentExportJobsRequest); /** *

* Retrieves information about the status and settings of the import jobs for a segment. *

* * @param getSegmentImportJobsRequest * @return Result of the GetSegmentImportJobs operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.GetSegmentImportJobs * @see AWS * API Documentation */ GetSegmentImportJobsResult getSegmentImportJobs(GetSegmentImportJobsRequest getSegmentImportJobsRequest); /** *

* Retrieves information about the configuration, dimension, and other settings for a specific version of a segment * that's associated with an application. *

* * @param getSegmentVersionRequest * @return Result of the GetSegmentVersion operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.GetSegmentVersion * @see AWS API * Documentation */ GetSegmentVersionResult getSegmentVersion(GetSegmentVersionRequest getSegmentVersionRequest); /** *

* Retrieves information about the configuration, dimension, and other settings for all the versions of a specific * segment that's associated with an application. *

* * @param getSegmentVersionsRequest * @return Result of the GetSegmentVersions operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.GetSegmentVersions * @see AWS * API Documentation */ GetSegmentVersionsResult getSegmentVersions(GetSegmentVersionsRequest getSegmentVersionsRequest); /** *

* Retrieves information about the configuration, dimension, and other settings for all the segments that are * associated with an application. *

* * @param getSegmentsRequest * @return Result of the GetSegments operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.GetSegments * @see AWS API * Documentation */ GetSegmentsResult getSegments(GetSegmentsRequest getSegmentsRequest); /** *

* Retrieves information about the status and settings of the SMS channel for an application. *

* * @param getSmsChannelRequest * @return Result of the GetSmsChannel operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.GetSmsChannel * @see AWS API * Documentation */ GetSmsChannelResult getSmsChannel(GetSmsChannelRequest getSmsChannelRequest); /** *

* Retrieves the content and settings of a message template for messages that are sent through the SMS channel. *

* * @param getSmsTemplateRequest * @return Result of the GetSmsTemplate operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.GetSmsTemplate * @see AWS API * Documentation */ GetSmsTemplateResult getSmsTemplate(GetSmsTemplateRequest getSmsTemplateRequest); /** *

* Retrieves information about all the endpoints that are associated with a specific user ID. *

* * @param getUserEndpointsRequest * @return Result of the GetUserEndpoints operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.GetUserEndpoints * @see AWS API * Documentation */ GetUserEndpointsResult getUserEndpoints(GetUserEndpointsRequest getUserEndpointsRequest); /** *

* Retrieves information about the status and settings of the voice channel for an application. *

* * @param getVoiceChannelRequest * @return Result of the GetVoiceChannel operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.GetVoiceChannel * @see AWS API * Documentation */ GetVoiceChannelResult getVoiceChannel(GetVoiceChannelRequest getVoiceChannelRequest); /** *

* Retrieves the content and settings of a message template for messages that are sent through the voice channel. *

* * @param getVoiceTemplateRequest * @return Result of the GetVoiceTemplate operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.GetVoiceTemplate * @see AWS API * Documentation */ GetVoiceTemplateResult getVoiceTemplate(GetVoiceTemplateRequest getVoiceTemplateRequest); /** *

* Retrieves information about the status, configuration, and other settings for all the journeys that are * associated with an application. *

* * @param listJourneysRequest * @return Result of the ListJourneys operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.ListJourneys * @see AWS API * Documentation */ ListJourneysResult listJourneys(ListJourneysRequest listJourneysRequest); /** *

* Retrieves all the tags (keys and values) that are associated with an application, campaign, message template, or * segment. *

* * @param listTagsForResourceRequest * @return Result of the ListTagsForResource operation returned by the service. * @sample AmazonPinpoint.ListTagsForResource * @see AWS * API Documentation */ ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest); /** *

* Retrieves information about all the versions of a specific message template. *

* * @param listTemplateVersionsRequest * @return Result of the ListTemplateVersions operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.ListTemplateVersions * @see AWS * API Documentation */ ListTemplateVersionsResult listTemplateVersions(ListTemplateVersionsRequest listTemplateVersionsRequest); /** *

* Retrieves information about all the message templates that are associated with your Amazon Pinpoint account. *

* * @param listTemplatesRequest * @return Result of the ListTemplates operation returned by the service. * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @sample AmazonPinpoint.ListTemplates * @see AWS API * Documentation */ ListTemplatesResult listTemplates(ListTemplatesRequest listTemplatesRequest); /** *

* Retrieves information about a phone number. *

* * @param phoneNumberValidateRequest * @return Result of the PhoneNumberValidate operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.PhoneNumberValidate * @see AWS * API Documentation */ PhoneNumberValidateResult phoneNumberValidate(PhoneNumberValidateRequest phoneNumberValidateRequest); /** *

* Creates a new event stream for an application or updates the settings of an existing event stream for an * application. *

* * @param putEventStreamRequest * @return Result of the PutEventStream operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.PutEventStream * @see AWS API * Documentation */ PutEventStreamResult putEventStream(PutEventStreamRequest putEventStreamRequest); /** *

* Creates a new event to record for endpoints, or creates or updates endpoint data that existing events are * associated with. *

* * @param putEventsRequest * @return Result of the PutEvents operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.PutEvents * @see AWS API * Documentation */ PutEventsResult putEvents(PutEventsRequest putEventsRequest); /** *

* Removes one or more attributes, of the same attribute type, from all the endpoints that are associated with an * application. *

* * @param removeAttributesRequest * @return Result of the RemoveAttributes operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.RemoveAttributes * @see AWS API * Documentation */ RemoveAttributesResult removeAttributes(RemoveAttributesRequest removeAttributesRequest); /** *

* Creates and sends a direct message. *

* * @param sendMessagesRequest * @return Result of the SendMessages operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.SendMessages * @see AWS API * Documentation */ SendMessagesResult sendMessages(SendMessagesRequest sendMessagesRequest); /** *

* Send an OTP message *

* * @param sendOTPMessageRequest * @return Result of the SendOTPMessage operation returned by the service. * @throws BadRequestException * 400 response * @throws InternalServerErrorException * 500 response * @throws PayloadTooLargeException * 413 response * @throws ForbiddenException * 403 response * @throws NotFoundException * 404 response * @throws MethodNotAllowedException * 405 response * @throws TooManyRequestsException * 429 response * @sample AmazonPinpoint.SendOTPMessage * @see AWS API * Documentation */ SendOTPMessageResult sendOTPMessage(SendOTPMessageRequest sendOTPMessageRequest); /** *

* Creates and sends a message to a list of users. *

* * @param sendUsersMessagesRequest * @return Result of the SendUsersMessages operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.SendUsersMessages * @see AWS API * Documentation */ SendUsersMessagesResult sendUsersMessages(SendUsersMessagesRequest sendUsersMessagesRequest); /** *

* Adds one or more tags (keys and values) to an application, campaign, message template, or segment. *

* * @param tagResourceRequest * @return Result of the TagResource operation returned by the service. * @sample AmazonPinpoint.TagResource * @see AWS API * Documentation */ TagResourceResult tagResource(TagResourceRequest tagResourceRequest); /** *

* Removes one or more tags (keys and values) from an application, campaign, message template, or segment. *

* * @param untagResourceRequest * @return Result of the UntagResource operation returned by the service. * @sample AmazonPinpoint.UntagResource * @see AWS API * Documentation */ UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest); /** *

* Enables the ADM channel for an application or updates the status and settings of the ADM channel for an * application. *

* * @param updateAdmChannelRequest * @return Result of the UpdateAdmChannel operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.UpdateAdmChannel * @see AWS API * Documentation */ UpdateAdmChannelResult updateAdmChannel(UpdateAdmChannelRequest updateAdmChannelRequest); /** *

* Enables the APNs channel for an application or updates the status and settings of the APNs channel for an * application. *

* * @param updateApnsChannelRequest * @return Result of the UpdateApnsChannel operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.UpdateApnsChannel * @see AWS API * Documentation */ UpdateApnsChannelResult updateApnsChannel(UpdateApnsChannelRequest updateApnsChannelRequest); /** *

* Enables the APNs sandbox channel for an application or updates the status and settings of the APNs sandbox * channel for an application. *

* * @param updateApnsSandboxChannelRequest * @return Result of the UpdateApnsSandboxChannel operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.UpdateApnsSandboxChannel * @see AWS API Documentation */ UpdateApnsSandboxChannelResult updateApnsSandboxChannel(UpdateApnsSandboxChannelRequest updateApnsSandboxChannelRequest); /** *

* Enables the APNs VoIP channel for an application or updates the status and settings of the APNs VoIP channel for * an application. *

* * @param updateApnsVoipChannelRequest * @return Result of the UpdateApnsVoipChannel operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.UpdateApnsVoipChannel * @see AWS * API Documentation */ UpdateApnsVoipChannelResult updateApnsVoipChannel(UpdateApnsVoipChannelRequest updateApnsVoipChannelRequest); /** *

* Enables the APNs VoIP sandbox channel for an application or updates the status and settings of the APNs VoIP * sandbox channel for an application. *

* * @param updateApnsVoipSandboxChannelRequest * @return Result of the UpdateApnsVoipSandboxChannel operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.UpdateApnsVoipSandboxChannel * @see AWS API Documentation */ UpdateApnsVoipSandboxChannelResult updateApnsVoipSandboxChannel(UpdateApnsVoipSandboxChannelRequest updateApnsVoipSandboxChannelRequest); /** *

* Updates the settings for an application. *

* * @param updateApplicationSettingsRequest * @return Result of the UpdateApplicationSettings operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.UpdateApplicationSettings * @see AWS API Documentation */ UpdateApplicationSettingsResult updateApplicationSettings(UpdateApplicationSettingsRequest updateApplicationSettingsRequest); /** *

* Enables the Baidu channel for an application or updates the status and settings of the Baidu channel for an * application. *

* * @param updateBaiduChannelRequest * @return Result of the UpdateBaiduChannel operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.UpdateBaiduChannel * @see AWS * API Documentation */ UpdateBaiduChannelResult updateBaiduChannel(UpdateBaiduChannelRequest updateBaiduChannelRequest); /** *

* Updates the configuration and other settings for a campaign. *

* * @param updateCampaignRequest * @return Result of the UpdateCampaign operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.UpdateCampaign * @see AWS API * Documentation */ UpdateCampaignResult updateCampaign(UpdateCampaignRequest updateCampaignRequest); /** *

* Enables the email channel for an application or updates the status and settings of the email channel for an * application. *

* * @param updateEmailChannelRequest * @return Result of the UpdateEmailChannel operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.UpdateEmailChannel * @see AWS * API Documentation */ UpdateEmailChannelResult updateEmailChannel(UpdateEmailChannelRequest updateEmailChannelRequest); /** *

* Updates an existing message template for messages that are sent through the email channel. *

* * @param updateEmailTemplateRequest * @return Result of the UpdateEmailTemplate operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.UpdateEmailTemplate * @see AWS * API Documentation */ UpdateEmailTemplateResult updateEmailTemplate(UpdateEmailTemplateRequest updateEmailTemplateRequest); /** *

* 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. *

* * @param updateEndpointRequest * @return Result of the UpdateEndpoint operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.UpdateEndpoint * @see AWS API * Documentation */ UpdateEndpointResult updateEndpoint(UpdateEndpointRequest updateEndpointRequest); /** *

* 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. *

* * @param updateEndpointsBatchRequest * @return Result of the UpdateEndpointsBatch operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.UpdateEndpointsBatch * @see AWS * API Documentation */ UpdateEndpointsBatchResult updateEndpointsBatch(UpdateEndpointsBatchRequest updateEndpointsBatchRequest); /** *

* Enables the GCM channel for an application or updates the status and settings of the GCM channel for an * application. *

* * @param updateGcmChannelRequest * @return Result of the UpdateGcmChannel operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.UpdateGcmChannel * @see AWS API * Documentation */ UpdateGcmChannelResult updateGcmChannel(UpdateGcmChannelRequest updateGcmChannelRequest); /** *

* Updates an existing message template for messages sent through the in-app message channel. *

* * @param updateInAppTemplateRequest * @return Result of the UpdateInAppTemplate operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.UpdateInAppTemplate * @see AWS * API Documentation */ UpdateInAppTemplateResult updateInAppTemplate(UpdateInAppTemplateRequest updateInAppTemplateRequest); /** *

* Updates the configuration and other settings for a journey. *

* * @param updateJourneyRequest * @return Result of the UpdateJourney operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @throws ConflictException * The request failed due to a conflict with the current state of the specified resource * (ConflictException). * @sample AmazonPinpoint.UpdateJourney * @see AWS API * Documentation */ UpdateJourneyResult updateJourney(UpdateJourneyRequest updateJourneyRequest); /** *

* Cancels (stops) an active journey. *

* * @param updateJourneyStateRequest * @return Result of the UpdateJourneyState operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.UpdateJourneyState * @see AWS * API Documentation */ UpdateJourneyStateResult updateJourneyState(UpdateJourneyStateRequest updateJourneyStateRequest); /** *

* Updates an existing message template for messages that are sent through a push notification channel. *

* * @param updatePushTemplateRequest * @return Result of the UpdatePushTemplate operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.UpdatePushTemplate * @see AWS * API Documentation */ UpdatePushTemplateResult updatePushTemplate(UpdatePushTemplateRequest updatePushTemplateRequest); /** *

* Updates an Amazon Pinpoint configuration for a recommender model. *

* * @param updateRecommenderConfigurationRequest * @return Result of the UpdateRecommenderConfiguration operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.UpdateRecommenderConfiguration * @see AWS API Documentation */ UpdateRecommenderConfigurationResult updateRecommenderConfiguration(UpdateRecommenderConfigurationRequest updateRecommenderConfigurationRequest); /** *

* 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. *

* * @param updateSegmentRequest * @return Result of the UpdateSegment operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.UpdateSegment * @see AWS API * Documentation */ UpdateSegmentResult updateSegment(UpdateSegmentRequest updateSegmentRequest); /** *

* Enables the SMS channel for an application or updates the status and settings of the SMS channel for an * application. *

* * @param updateSmsChannelRequest * @return Result of the UpdateSmsChannel operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.UpdateSmsChannel * @see AWS API * Documentation */ UpdateSmsChannelResult updateSmsChannel(UpdateSmsChannelRequest updateSmsChannelRequest); /** *

* Updates an existing message template for messages that are sent through the SMS channel. *

* * @param updateSmsTemplateRequest * @return Result of the UpdateSmsTemplate operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.UpdateSmsTemplate * @see AWS API * Documentation */ UpdateSmsTemplateResult updateSmsTemplate(UpdateSmsTemplateRequest updateSmsTemplateRequest); /** *

* Changes the status of a specific version of a message template to active. *

* * @param updateTemplateActiveVersionRequest * @return Result of the UpdateTemplateActiveVersion operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.UpdateTemplateActiveVersion * @see AWS API Documentation */ UpdateTemplateActiveVersionResult updateTemplateActiveVersion(UpdateTemplateActiveVersionRequest updateTemplateActiveVersionRequest); /** *

* Enables the voice channel for an application or updates the status and settings of the voice channel for an * application. *

* * @param updateVoiceChannelRequest * @return Result of the UpdateVoiceChannel operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.UpdateVoiceChannel * @see AWS * API Documentation */ UpdateVoiceChannelResult updateVoiceChannel(UpdateVoiceChannelRequest updateVoiceChannelRequest); /** *

* Updates an existing message template for messages that are sent through the voice channel. *

* * @param updateVoiceTemplateRequest * @return Result of the UpdateVoiceTemplate operation returned by the service. * @throws BadRequestException * The request contains a syntax error (BadRequestException). * @throws InternalServerErrorException * The request failed due to an unknown internal server error, exception, or failure * (InternalServerErrorException). * @throws PayloadTooLargeException * The request failed because the payload for the body of the request is too large * (RequestEntityTooLargeException). * @throws ForbiddenException * The request was denied because access to the specified resource is forbidden (ForbiddenException). * @throws NotFoundException * The request failed because the specified resource was not found (NotFoundException). * @throws MethodNotAllowedException * The request failed because the method is not allowed for the specified resource * (MethodNotAllowedException). * @throws TooManyRequestsException * The request failed because too many requests were sent during a certain amount of time * (TooManyRequestsException). * @sample AmazonPinpoint.UpdateVoiceTemplate * @see AWS * API Documentation */ UpdateVoiceTemplateResult updateVoiceTemplate(UpdateVoiceTemplateRequest updateVoiceTemplateRequest); /** *

* Verify an OTP *

* * @param verifyOTPMessageRequest * @return Result of the VerifyOTPMessage operation returned by the service. * @throws BadRequestException * 400 response * @throws InternalServerErrorException * 500 response * @throws PayloadTooLargeException * 413 response * @throws ForbiddenException * 403 response * @throws NotFoundException * 404 response * @throws MethodNotAllowedException * 405 response * @throws TooManyRequestsException * 429 response * @sample AmazonPinpoint.VerifyOTPMessage * @see AWS API * Documentation */ VerifyOTPMessageResult verifyOTPMessage(VerifyOTPMessageRequest verifyOTPMessageRequest); /** * Shuts down this client object, releasing any resources that might be held open. This is an optional method, and * callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client * has been shutdown, it should not be used to make any more requests. */ void shutdown(); /** * Returns additional metadata for a previously executed successful request, typically used for debugging issues * where a service isn't acting as expected. This data isn't considered part of the result data returned by an * operation, so it's available through this separate, diagnostic interface. *

* Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic * information for an executed request, you should use this method to retrieve it as soon as possible after * executing a request. * * @param request * The originally executed request. * * @return The response metadata for the specified request, or null if none is available. */ ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request); }