AmazonPinpoint (AWS SDK for Java

All Known Subinterfaces:

AmazonPinpointAsync

All Known Implementing Classes:

AbstractAmazonPinpoint, AbstractAmazonPinpointAsync, AmazonPinpointAsyncClient, AmazonPinpointClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonPinpoint
```
Interface for accessing Amazon Pinpoint.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonPinpoint instead.

Doc Engage API - Amazon Pinpoint API

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`CreateAppResult`	`createApp(CreateAppRequest createAppRequest)` Creates an application.
`CreateCampaignResult`	`createCampaign(CreateCampaignRequest createCampaignRequest)` Creates a new campaign for an application or updates the settings of an existing campaign for an application.
`CreateEmailTemplateResult`	`createEmailTemplate(CreateEmailTemplateRequest createEmailTemplateRequest)` Creates a message template for messages that are sent through the email channel.
`CreateExportJobResult`	`createExportJob(CreateExportJobRequest createExportJobRequest)` Creates an export job for an application.
`CreateImportJobResult`	`createImportJob(CreateImportJobRequest createImportJobRequest)` Creates an import job for an application.
`CreateInAppTemplateResult`	`createInAppTemplate(CreateInAppTemplateRequest createInAppTemplateRequest)` Creates a new message template for messages using the in-app message channel.
`CreateJourneyResult`	`createJourney(CreateJourneyRequest createJourneyRequest)` Creates a journey for an application.
`CreatePushTemplateResult`	`createPushTemplate(CreatePushTemplateRequest createPushTemplateRequest)` Creates a message template for messages that are sent through a push notification channel.
`CreateRecommenderConfigurationResult`	`createRecommenderConfiguration(CreateRecommenderConfigurationRequest createRecommenderConfigurationRequest)` Creates an Amazon Pinpoint configuration for a recommender model.
`CreateSegmentResult`	`createSegment(CreateSegmentRequest createSegmentRequest)` Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.
`CreateSmsTemplateResult`	`createSmsTemplate(CreateSmsTemplateRequest createSmsTemplateRequest)` Creates a message template for messages that are sent through the SMS channel.
`CreateVoiceTemplateResult`	`createVoiceTemplate(CreateVoiceTemplateRequest createVoiceTemplateRequest)` Creates a message template for messages that are sent through the voice channel.
`DeleteAdmChannelResult`	`deleteAdmChannel(DeleteAdmChannelRequest deleteAdmChannelRequest)` Disables the ADM channel for an application and deletes any existing settings for the channel.
`DeleteApnsChannelResult`	`deleteApnsChannel(DeleteApnsChannelRequest deleteApnsChannelRequest)` Disables the APNs channel for an application and deletes any existing settings for the channel.
`DeleteApnsSandboxChannelResult`	`deleteApnsSandboxChannel(DeleteApnsSandboxChannelRequest deleteApnsSandboxChannelRequest)` Disables the APNs sandbox channel for an application and deletes any existing settings for the channel.
`DeleteApnsVoipChannelResult`	`deleteApnsVoipChannel(DeleteApnsVoipChannelRequest deleteApnsVoipChannelRequest)` Disables the APNs VoIP channel for an application and deletes any existing settings for the channel.
`DeleteApnsVoipSandboxChannelResult`	`deleteApnsVoipSandboxChannel(DeleteApnsVoipSandboxChannelRequest deleteApnsVoipSandboxChannelRequest)` Disables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel.
`DeleteAppResult`	`deleteApp(DeleteAppRequest deleteAppRequest)` Deletes an application.
`DeleteBaiduChannelResult`	`deleteBaiduChannel(DeleteBaiduChannelRequest deleteBaiduChannelRequest)` Disables the Baidu channel for an application and deletes any existing settings for the channel.
`DeleteCampaignResult`	`deleteCampaign(DeleteCampaignRequest deleteCampaignRequest)` Deletes a campaign from an application.
`DeleteEmailChannelResult`	`deleteEmailChannel(DeleteEmailChannelRequest deleteEmailChannelRequest)` Disables the email channel for an application and deletes any existing settings for the channel.
`DeleteEmailTemplateResult`	`deleteEmailTemplate(DeleteEmailTemplateRequest deleteEmailTemplateRequest)` Deletes a message template for messages that were sent through the email channel.
`DeleteEndpointResult`	`deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest)` Deletes an endpoint from an application.
`DeleteEventStreamResult`	`deleteEventStream(DeleteEventStreamRequest deleteEventStreamRequest)` Deletes the event stream for an application.
`DeleteGcmChannelResult`	`deleteGcmChannel(DeleteGcmChannelRequest deleteGcmChannelRequest)` Disables the GCM channel for an application and deletes any existing settings for the channel.
`DeleteInAppTemplateResult`	`deleteInAppTemplate(DeleteInAppTemplateRequest deleteInAppTemplateRequest)` Deletes a message template for messages sent using the in-app message channel.
`DeleteJourneyResult`	`deleteJourney(DeleteJourneyRequest deleteJourneyRequest)` Deletes a journey from an application.
`DeletePushTemplateResult`	`deletePushTemplate(DeletePushTemplateRequest deletePushTemplateRequest)` Deletes a message template for messages that were sent through a push notification channel.
`DeleteRecommenderConfigurationResult`	`deleteRecommenderConfiguration(DeleteRecommenderConfigurationRequest deleteRecommenderConfigurationRequest)` Deletes an Amazon Pinpoint configuration for a recommender model.
`DeleteSegmentResult`	`deleteSegment(DeleteSegmentRequest deleteSegmentRequest)` Deletes a segment from an application.
`DeleteSmsChannelResult`	`deleteSmsChannel(DeleteSmsChannelRequest deleteSmsChannelRequest)` Disables the SMS channel for an application and deletes any existing settings for the channel.
`DeleteSmsTemplateResult`	`deleteSmsTemplate(DeleteSmsTemplateRequest deleteSmsTemplateRequest)` Deletes a message template for messages that were sent through the SMS channel.
`DeleteUserEndpointsResult`	`deleteUserEndpoints(DeleteUserEndpointsRequest deleteUserEndpointsRequest)` Deletes all the endpoints that are associated with a specific user ID.
`DeleteVoiceChannelResult`	`deleteVoiceChannel(DeleteVoiceChannelRequest deleteVoiceChannelRequest)` Disables the voice channel for an application and deletes any existing settings for the channel.
`DeleteVoiceTemplateResult`	`deleteVoiceTemplate(DeleteVoiceTemplateRequest deleteVoiceTemplateRequest)` Deletes a message template for messages that were sent through the voice channel.
`GetAdmChannelResult`	`getAdmChannel(GetAdmChannelRequest getAdmChannelRequest)` Retrieves information about the status and settings of the ADM channel for an application.
`GetApnsChannelResult`	`getApnsChannel(GetApnsChannelRequest getApnsChannelRequest)` Retrieves information about the status and settings of the APNs channel for an application.
`GetApnsSandboxChannelResult`	`getApnsSandboxChannel(GetApnsSandboxChannelRequest getApnsSandboxChannelRequest)` Retrieves information about the status and settings of the APNs sandbox channel for an application.
`GetApnsVoipChannelResult`	`getApnsVoipChannel(GetApnsVoipChannelRequest getApnsVoipChannelRequest)` Retrieves information about the status and settings of the APNs VoIP channel for an application.
`GetApnsVoipSandboxChannelResult`	`getApnsVoipSandboxChannel(GetApnsVoipSandboxChannelRequest getApnsVoipSandboxChannelRequest)` Retrieves information about the status and settings of the APNs VoIP sandbox channel for an application.
`GetAppResult`	`getApp(GetAppRequest getAppRequest)` Retrieves information about an application.
`GetApplicationDateRangeKpiResult`	`getApplicationDateRangeKpi(GetApplicationDateRangeKpiRequest getApplicationDateRangeKpiRequest)` Retrieves (queries) pre-aggregated data for a standard metric that applies to an application.
`GetApplicationSettingsResult`	`getApplicationSettings(GetApplicationSettingsRequest getApplicationSettingsRequest)` Retrieves information about the settings for an application.
`GetAppsResult`	`getApps(GetAppsRequest getAppsRequest)` Retrieves information about all the applications that are associated with your Amazon Pinpoint account.
`GetBaiduChannelResult`	`getBaiduChannel(GetBaiduChannelRequest getBaiduChannelRequest)` Retrieves information about the status and settings of the Baidu channel for an application.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetCampaignResult`	`getCampaign(GetCampaignRequest getCampaignRequest)` Retrieves information about the status, configuration, and other settings for a campaign.
`GetCampaignActivitiesResult`	`getCampaignActivities(GetCampaignActivitiesRequest getCampaignActivitiesRequest)` Retrieves information about all the activities for a campaign.
`GetCampaignDateRangeKpiResult`	`getCampaignDateRangeKpi(GetCampaignDateRangeKpiRequest getCampaignDateRangeKpiRequest)` Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign.
`GetCampaignsResult`	`getCampaigns(GetCampaignsRequest getCampaignsRequest)` Retrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application.
`GetCampaignVersionResult`	`getCampaignVersion(GetCampaignVersionRequest getCampaignVersionRequest)` Retrieves information about the status, configuration, and other settings for a specific version of a campaign.
`GetCampaignVersionsResult`	`getCampaignVersions(GetCampaignVersionsRequest getCampaignVersionsRequest)` Retrieves information about the status, configuration, and other settings for all versions of a campaign.
`GetChannelsResult`	`getChannels(GetChannelsRequest getChannelsRequest)` Retrieves information about the history and status of each channel for an application.
`GetEmailChannelResult`	`getEmailChannel(GetEmailChannelRequest getEmailChannelRequest)` Retrieves information about the status and settings of the email channel for an application.
`GetEmailTemplateResult`	`getEmailTemplate(GetEmailTemplateRequest getEmailTemplateRequest)` Retrieves the content and settings of a message template for messages that are sent through the email channel.
`GetEndpointResult`	`getEndpoint(GetEndpointRequest getEndpointRequest)` Retrieves information about the settings and attributes of a specific endpoint for an application.
`GetEventStreamResult`	`getEventStream(GetEventStreamRequest getEventStreamRequest)` Retrieves information about the event stream settings for an application.
`GetExportJobResult`	`getExportJob(GetExportJobRequest getExportJobRequest)` Retrieves information about the status and settings of a specific export job for an application.
`GetExportJobsResult`	`getExportJobs(GetExportJobsRequest getExportJobsRequest)` Retrieves information about the status and settings of all the export jobs for an application.
`GetGcmChannelResult`	`getGcmChannel(GetGcmChannelRequest getGcmChannelRequest)` Retrieves information about the status and settings of the GCM channel for an application.
`GetImportJobResult`	`getImportJob(GetImportJobRequest getImportJobRequest)` Retrieves information about the status and settings of a specific import job for an application.
`GetImportJobsResult`	`getImportJobs(GetImportJobsRequest getImportJobsRequest)` Retrieves information about the status and settings of all the import jobs for an application.
`GetInAppMessagesResult`	`getInAppMessages(GetInAppMessagesRequest getInAppMessagesRequest)` Retrieves the in-app messages targeted for the provided endpoint ID.
`GetInAppTemplateResult`	`getInAppTemplate(GetInAppTemplateRequest getInAppTemplateRequest)` Retrieves the content and settings of a message template for messages sent through the in-app channel.
`GetJourneyResult`	`getJourney(GetJourneyRequest getJourneyRequest)` Retrieves information about the status, configuration, and other settings for a journey.
`GetJourneyDateRangeKpiResult`	`getJourneyDateRangeKpi(GetJourneyDateRangeKpiRequest getJourneyDateRangeKpiRequest)` Retrieves (queries) pre-aggregated data for a standard engagement metric that applies to a journey.
`GetJourneyExecutionActivityMetricsResult`	`getJourneyExecutionActivityMetrics(GetJourneyExecutionActivityMetricsRequest getJourneyExecutionActivityMetricsRequest)` Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey activity.
`GetJourneyExecutionMetricsResult`	`getJourneyExecutionMetrics(GetJourneyExecutionMetricsRequest getJourneyExecutionMetricsRequest)` Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey.
`GetPushTemplateResult`	`getPushTemplate(GetPushTemplateRequest getPushTemplateRequest)` Retrieves the content and settings of a message template for messages that are sent through a push notification channel.
`GetRecommenderConfigurationResult`	`getRecommenderConfiguration(GetRecommenderConfigurationRequest getRecommenderConfigurationRequest)` Retrieves information about an Amazon Pinpoint configuration for a recommender model.
`GetRecommenderConfigurationsResult`	`getRecommenderConfigurations(GetRecommenderConfigurationsRequest getRecommenderConfigurationsRequest)` Retrieves information about all the recommender model configurations that are associated with your Amazon Pinpoint account.
`GetSegmentResult`	`getSegment(GetSegmentRequest getSegmentRequest)` Retrieves information about the configuration, dimension, and other settings for a specific segment that's associated with an application.
`GetSegmentExportJobsResult`	`getSegmentExportJobs(GetSegmentExportJobsRequest getSegmentExportJobsRequest)` Retrieves information about the status and settings of the export jobs for a segment.
`GetSegmentImportJobsResult`	`getSegmentImportJobs(GetSegmentImportJobsRequest getSegmentImportJobsRequest)` Retrieves information about the status and settings of the import jobs for a segment.
`GetSegmentsResult`	`getSegments(GetSegmentsRequest getSegmentsRequest)` Retrieves information about the configuration, dimension, and other settings for all the segments that are associated with an application.
`GetSegmentVersionResult`	`getSegmentVersion(GetSegmentVersionRequest getSegmentVersionRequest)` Retrieves information about the configuration, dimension, and other settings for a specific version of a segment that's associated with an application.
`GetSegmentVersionsResult`	`getSegmentVersions(GetSegmentVersionsRequest getSegmentVersionsRequest)` Retrieves information about the configuration, dimension, and other settings for all the versions of a specific segment that's associated with an application.
`GetSmsChannelResult`	`getSmsChannel(GetSmsChannelRequest getSmsChannelRequest)` Retrieves information about the status and settings of the SMS channel for an application.
`GetSmsTemplateResult`	`getSmsTemplate(GetSmsTemplateRequest getSmsTemplateRequest)` Retrieves the content and settings of a message template for messages that are sent through the SMS channel.
`GetUserEndpointsResult`	`getUserEndpoints(GetUserEndpointsRequest getUserEndpointsRequest)` Retrieves information about all the endpoints that are associated with a specific user ID.
`GetVoiceChannelResult`	`getVoiceChannel(GetVoiceChannelRequest getVoiceChannelRequest)` Retrieves information about the status and settings of the voice channel for an application.
`GetVoiceTemplateResult`	`getVoiceTemplate(GetVoiceTemplateRequest getVoiceTemplateRequest)` Retrieves the content and settings of a message template for messages that are sent through the voice channel.
`ListJourneysResult`	`listJourneys(ListJourneysRequest listJourneysRequest)` Retrieves information about the status, configuration, and other settings for all the journeys that are associated with an application.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)` Retrieves all the tags (keys and values) that are associated with an application, campaign, message template, or segment.
`ListTemplatesResult`	`listTemplates(ListTemplatesRequest listTemplatesRequest)` Retrieves information about all the message templates that are associated with your Amazon Pinpoint account.
`ListTemplateVersionsResult`	`listTemplateVersions(ListTemplateVersionsRequest listTemplateVersionsRequest)` Retrieves information about all the versions of a specific message template.
`PhoneNumberValidateResult`	`phoneNumberValidate(PhoneNumberValidateRequest phoneNumberValidateRequest)` Retrieves information about a phone number.
`PutEventsResult`	`putEvents(PutEventsRequest putEventsRequest)` Creates a new event to record for endpoints, or creates or updates endpoint data that existing events are associated with.
`PutEventStreamResult`	`putEventStream(PutEventStreamRequest putEventStreamRequest)` Creates a new event stream for an application or updates the settings of an existing event stream for an application.
`RemoveAttributesResult`	`removeAttributes(RemoveAttributesRequest removeAttributesRequest)` Removes one or more attributes, of the same attribute type, from all the endpoints that are associated with an application.
`SendMessagesResult`	`sendMessages(SendMessagesRequest sendMessagesRequest)` Creates and sends a direct message.
`SendOTPMessageResult`	`sendOTPMessage(SendOTPMessageRequest sendOTPMessageRequest)` Send an OTP message
`SendUsersMessagesResult`	`sendUsersMessages(SendUsersMessagesRequest sendUsersMessagesRequest)` Creates and sends a message to a list of users.
`void`	`setEndpoint(String endpoint)` Deprecated. use `AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)` for example: `builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));`
`void`	`setRegion(Region region)` Deprecated. use `AwsClientBuilder#setRegion(String)`
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`TagResourceResult`	`tagResource(TagResourceRequest tagResourceRequest)` Adds one or more tags (keys and values) to an application, campaign, message template, or segment.
`UntagResourceResult`	`untagResource(UntagResourceRequest untagResourceRequest)` Removes one or more tags (keys and values) from an application, campaign, message template, or segment.
`UpdateAdmChannelResult`	`updateAdmChannel(UpdateAdmChannelRequest updateAdmChannelRequest)` Enables the ADM channel for an application or updates the status and settings of the ADM channel for an application.
`UpdateApnsChannelResult`	`updateApnsChannel(UpdateApnsChannelRequest updateApnsChannelRequest)` Enables the APNs channel for an application or updates the status and settings of the APNs channel for an application.
`UpdateApnsSandboxChannelResult`	`updateApnsSandboxChannel(UpdateApnsSandboxChannelRequest updateApnsSandboxChannelRequest)` Enables the APNs sandbox channel for an application or updates the status and settings of the APNs sandbox channel for an application.
`UpdateApnsVoipChannelResult`	`updateApnsVoipChannel(UpdateApnsVoipChannelRequest updateApnsVoipChannelRequest)` Enables the APNs VoIP channel for an application or updates the status and settings of the APNs VoIP channel for an application.
`UpdateApnsVoipSandboxChannelResult`	`updateApnsVoipSandboxChannel(UpdateApnsVoipSandboxChannelRequest updateApnsVoipSandboxChannelRequest)` Enables the APNs VoIP sandbox channel for an application or updates the status and settings of the APNs VoIP sandbox channel for an application.
`UpdateApplicationSettingsResult`	`updateApplicationSettings(UpdateApplicationSettingsRequest updateApplicationSettingsRequest)` Updates the settings for an application.
`UpdateBaiduChannelResult`	`updateBaiduChannel(UpdateBaiduChannelRequest updateBaiduChannelRequest)` Enables the Baidu channel for an application or updates the status and settings of the Baidu channel for an application.
`UpdateCampaignResult`	`updateCampaign(UpdateCampaignRequest updateCampaignRequest)` Updates the configuration and other settings for a campaign.
`UpdateEmailChannelResult`	`updateEmailChannel(UpdateEmailChannelRequest updateEmailChannelRequest)` Enables the email channel for an application or updates the status and settings of the email channel for an application.
`UpdateEmailTemplateResult`	`updateEmailTemplate(UpdateEmailTemplateRequest updateEmailTemplateRequest)` Updates an existing message template for messages that are sent through the email channel.
`UpdateEndpointResult`	`updateEndpoint(UpdateEndpointRequest updateEndpointRequest)` Creates a new endpoint for an application or updates the settings and attributes of an existing endpoint for an application.
`UpdateEndpointsBatchResult`	`updateEndpointsBatch(UpdateEndpointsBatchRequest updateEndpointsBatchRequest)` Creates a new batch of endpoints for an application or updates the settings and attributes of a batch of existing endpoints for an application.
`UpdateGcmChannelResult`	`updateGcmChannel(UpdateGcmChannelRequest updateGcmChannelRequest)` Enables the GCM channel for an application or updates the status and settings of the GCM channel for an application.
`UpdateInAppTemplateResult`	`updateInAppTemplate(UpdateInAppTemplateRequest updateInAppTemplateRequest)` Updates an existing message template for messages sent through the in-app message channel.
`UpdateJourneyResult`	`updateJourney(UpdateJourneyRequest updateJourneyRequest)` Updates the configuration and other settings for a journey.
`UpdateJourneyStateResult`	`updateJourneyState(UpdateJourneyStateRequest updateJourneyStateRequest)` Cancels (stops) an active journey.
`UpdatePushTemplateResult`	`updatePushTemplate(UpdatePushTemplateRequest updatePushTemplateRequest)` Updates an existing message template for messages that are sent through a push notification channel.
`UpdateRecommenderConfigurationResult`	`updateRecommenderConfiguration(UpdateRecommenderConfigurationRequest updateRecommenderConfigurationRequest)` Updates an Amazon Pinpoint configuration for a recommender model.
`UpdateSegmentResult`	`updateSegment(UpdateSegmentRequest updateSegmentRequest)` Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.
`UpdateSmsChannelResult`	`updateSmsChannel(UpdateSmsChannelRequest updateSmsChannelRequest)` Enables the SMS channel for an application or updates the status and settings of the SMS channel for an application.
`UpdateSmsTemplateResult`	`updateSmsTemplate(UpdateSmsTemplateRequest updateSmsTemplateRequest)` Updates an existing message template for messages that are sent through the SMS channel.
`UpdateTemplateActiveVersionResult`	`updateTemplateActiveVersion(UpdateTemplateActiveVersionRequest updateTemplateActiveVersionRequest)` Changes the status of a specific version of a message template to active.
`UpdateVoiceChannelResult`	`updateVoiceChannel(UpdateVoiceChannelRequest updateVoiceChannelRequest)` Enables the voice channel for an application or updates the status and settings of the voice channel for an application.
`UpdateVoiceTemplateResult`	`updateVoiceTemplate(UpdateVoiceTemplateRequest updateVoiceTemplateRequest)` Updates an existing message template for messages that are sent through the voice channel.
`VerifyOTPMessageResult`	`verifyOTPMessage(VerifyOTPMessageRequest verifyOTPMessageRequest)` Verify an OTP

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    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 Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - setEndpoint
```
@Deprecated
void setEndpoint(String endpoint)
```
    Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
    
    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 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.
    
    Parameters:
    
    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.
  - setRegion
```
@Deprecated
void setRegion(Region region)
```
    Deprecated. use AwsClientBuilder#setRegion(String)
    
    An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.
    By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.
    This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Parameters:
    
    region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.
    
    See Also:
    
    Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)
  - createApp
```
CreateAppResult createApp(CreateAppRequest createAppRequest)
```
    Creates an application.
    
    Parameters:
    
    createAppRequest -
    
    Returns:
    
    Result of the CreateApp operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - createCampaign
```
CreateCampaignResult createCampaign(CreateCampaignRequest createCampaignRequest)
```
    Creates a new campaign for an application or updates the settings of an existing campaign for an application.
    
    Parameters:
    
    createCampaignRequest -
    
    Returns:
    
    Result of the CreateCampaign operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - createEmailTemplate
```
CreateEmailTemplateResult createEmailTemplate(CreateEmailTemplateRequest createEmailTemplateRequest)
```
    Creates a message template for messages that are sent through the email channel.
    
    Parameters:
    
    createEmailTemplateRequest -
    
    Returns:
    
    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).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    See Also:
    
    AWS API Documentation
  - createExportJob
```
CreateExportJobResult createExportJob(CreateExportJobRequest createExportJobRequest)
```
    Creates an export job for an application.
    
    Parameters:
    
    createExportJobRequest -
    
    Returns:
    
    Result of the CreateExportJob operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - createImportJob
```
CreateImportJobResult createImportJob(CreateImportJobRequest createImportJobRequest)
```
    Creates an import job for an application.
    
    Parameters:
    
    createImportJobRequest -
    
    Returns:
    
    Result of the CreateImportJob operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - createInAppTemplate
```
CreateInAppTemplateResult createInAppTemplate(CreateInAppTemplateRequest createInAppTemplateRequest)
```
    Creates a new message template for messages using the in-app message channel.
    
    Parameters:
    
    createInAppTemplateRequest -
    
    Returns:
    
    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).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    See Also:
    
    AWS API Documentation
  - createJourney
```
CreateJourneyResult createJourney(CreateJourneyRequest createJourneyRequest)
```
    Creates a journey for an application.
    
    Parameters:
    
    createJourneyRequest -
    
    Returns:
    
    Result of the CreateJourney operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - createPushTemplate
```
CreatePushTemplateResult createPushTemplate(CreatePushTemplateRequest createPushTemplateRequest)
```
    Creates a message template for messages that are sent through a push notification channel.
    
    Parameters:
    
    createPushTemplateRequest -
    
    Returns:
    
    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).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    See Also:
    
    AWS API Documentation
  - createRecommenderConfiguration
```
CreateRecommenderConfigurationResult createRecommenderConfiguration(CreateRecommenderConfigurationRequest createRecommenderConfigurationRequest)
```
    Creates an Amazon Pinpoint configuration for a recommender model.
    
    Parameters:
    
    createRecommenderConfigurationRequest -
    
    Returns:
    
    Result of the CreateRecommenderConfiguration operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - createSegment
```
CreateSegmentResult createSegment(CreateSegmentRequest createSegmentRequest)
```
    Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.
    
    Parameters:
    
    createSegmentRequest -
    
    Returns:
    
    Result of the CreateSegment operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - createSmsTemplate
```
CreateSmsTemplateResult createSmsTemplate(CreateSmsTemplateRequest createSmsTemplateRequest)
```
    Creates a message template for messages that are sent through the SMS channel.
    
    Parameters:
    
    createSmsTemplateRequest -
    
    Returns:
    
    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).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    See Also:
    
    AWS API Documentation
  - createVoiceTemplate
```
CreateVoiceTemplateResult createVoiceTemplate(CreateVoiceTemplateRequest createVoiceTemplateRequest)
```
    Creates a message template for messages that are sent through the voice channel.
    
    Parameters:
    
    createVoiceTemplateRequest -
    
    Returns:
    
    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).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    See Also:
    
    AWS API Documentation
  - deleteAdmChannel
```
DeleteAdmChannelResult deleteAdmChannel(DeleteAdmChannelRequest deleteAdmChannelRequest)
```
    Disables the ADM channel for an application and deletes any existing settings for the channel.
    
    Parameters:
    
    deleteAdmChannelRequest -
    
    Returns:
    
    Result of the DeleteAdmChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - deleteApnsChannel
```
DeleteApnsChannelResult deleteApnsChannel(DeleteApnsChannelRequest deleteApnsChannelRequest)
```
    Disables the APNs channel for an application and deletes any existing settings for the channel.
    
    Parameters:
    
    deleteApnsChannelRequest -
    
    Returns:
    
    Result of the DeleteApnsChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - deleteApnsSandboxChannel
```
DeleteApnsSandboxChannelResult deleteApnsSandboxChannel(DeleteApnsSandboxChannelRequest deleteApnsSandboxChannelRequest)
```
    Disables the APNs sandbox channel for an application and deletes any existing settings for the channel.
    
    Parameters:
    
    deleteApnsSandboxChannelRequest -
    
    Returns:
    
    Result of the DeleteApnsSandboxChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - deleteApnsVoipChannel
```
DeleteApnsVoipChannelResult deleteApnsVoipChannel(DeleteApnsVoipChannelRequest deleteApnsVoipChannelRequest)
```
    Disables the APNs VoIP channel for an application and deletes any existing settings for the channel.
    
    Parameters:
    
    deleteApnsVoipChannelRequest -
    
    Returns:
    
    Result of the DeleteApnsVoipChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - deleteApnsVoipSandboxChannel
```
DeleteApnsVoipSandboxChannelResult deleteApnsVoipSandboxChannel(DeleteApnsVoipSandboxChannelRequest deleteApnsVoipSandboxChannelRequest)
```
    Disables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel.
    
    Parameters:
    
    deleteApnsVoipSandboxChannelRequest -
    
    Returns:
    
    Result of the DeleteApnsVoipSandboxChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - deleteApp
```
DeleteAppResult deleteApp(DeleteAppRequest deleteAppRequest)
```
    Deletes an application.
    
    Parameters:
    
    deleteAppRequest -
    
    Returns:
    
    Result of the DeleteApp operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - deleteBaiduChannel
```
DeleteBaiduChannelResult deleteBaiduChannel(DeleteBaiduChannelRequest deleteBaiduChannelRequest)
```
    Disables the Baidu channel for an application and deletes any existing settings for the channel.
    
    Parameters:
    
    deleteBaiduChannelRequest -
    
    Returns:
    
    Result of the DeleteBaiduChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - deleteCampaign
```
DeleteCampaignResult deleteCampaign(DeleteCampaignRequest deleteCampaignRequest)
```
    Deletes a campaign from an application.
    
    Parameters:
    
    deleteCampaignRequest -
    
    Returns:
    
    Result of the DeleteCampaign operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - deleteEmailChannel
```
DeleteEmailChannelResult deleteEmailChannel(DeleteEmailChannelRequest deleteEmailChannelRequest)
```
    Disables the email channel for an application and deletes any existing settings for the channel.
    
    Parameters:
    
    deleteEmailChannelRequest -
    
    Returns:
    
    Result of the DeleteEmailChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - deleteEmailTemplate
```
DeleteEmailTemplateResult deleteEmailTemplate(DeleteEmailTemplateRequest deleteEmailTemplateRequest)
```
    Deletes a message template for messages that were sent through the email channel.
    
    Parameters:
    
    deleteEmailTemplateRequest -
    
    Returns:
    
    Result of the DeleteEmailTemplate operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - deleteEndpoint
```
DeleteEndpointResult deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest)
```
    Deletes an endpoint from an application.
    
    Parameters:
    
    deleteEndpointRequest -
    
    Returns:
    
    Result of the DeleteEndpoint operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - deleteEventStream
```
DeleteEventStreamResult deleteEventStream(DeleteEventStreamRequest deleteEventStreamRequest)
```
    Deletes the event stream for an application.
    
    Parameters:
    
    deleteEventStreamRequest -
    
    Returns:
    
    Result of the DeleteEventStream operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - deleteGcmChannel
```
DeleteGcmChannelResult deleteGcmChannel(DeleteGcmChannelRequest deleteGcmChannelRequest)
```
    Disables the GCM channel for an application and deletes any existing settings for the channel.
    
    Parameters:
    
    deleteGcmChannelRequest -
    
    Returns:
    
    Result of the DeleteGcmChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - deleteInAppTemplate
```
DeleteInAppTemplateResult deleteInAppTemplate(DeleteInAppTemplateRequest deleteInAppTemplateRequest)
```
    Deletes a message template for messages sent using the in-app message channel.
    
    Parameters:
    
    deleteInAppTemplateRequest -
    
    Returns:
    
    Result of the DeleteInAppTemplate operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - deleteJourney
```
DeleteJourneyResult deleteJourney(DeleteJourneyRequest deleteJourneyRequest)
```
    Deletes a journey from an application.
    
    Parameters:
    
    deleteJourneyRequest -
    
    Returns:
    
    Result of the DeleteJourney operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - deletePushTemplate
```
DeletePushTemplateResult deletePushTemplate(DeletePushTemplateRequest deletePushTemplateRequest)
```
    Deletes a message template for messages that were sent through a push notification channel.
    
    Parameters:
    
    deletePushTemplateRequest -
    
    Returns:
    
    Result of the DeletePushTemplate operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - deleteRecommenderConfiguration
```
DeleteRecommenderConfigurationResult deleteRecommenderConfiguration(DeleteRecommenderConfigurationRequest deleteRecommenderConfigurationRequest)
```
    Deletes an Amazon Pinpoint configuration for a recommender model.
    
    Parameters:
    
    deleteRecommenderConfigurationRequest -
    
    Returns:
    
    Result of the DeleteRecommenderConfiguration operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - deleteSegment
```
DeleteSegmentResult deleteSegment(DeleteSegmentRequest deleteSegmentRequest)
```
    Deletes a segment from an application.
    
    Parameters:
    
    deleteSegmentRequest -
    
    Returns:
    
    Result of the DeleteSegment operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - deleteSmsChannel
```
DeleteSmsChannelResult deleteSmsChannel(DeleteSmsChannelRequest deleteSmsChannelRequest)
```
    Disables the SMS channel for an application and deletes any existing settings for the channel.
    
    Parameters:
    
    deleteSmsChannelRequest -
    
    Returns:
    
    Result of the DeleteSmsChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - deleteSmsTemplate
```
DeleteSmsTemplateResult deleteSmsTemplate(DeleteSmsTemplateRequest deleteSmsTemplateRequest)
```
    Deletes a message template for messages that were sent through the SMS channel.
    
    Parameters:
    
    deleteSmsTemplateRequest -
    
    Returns:
    
    Result of the DeleteSmsTemplate operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - deleteUserEndpoints
```
DeleteUserEndpointsResult deleteUserEndpoints(DeleteUserEndpointsRequest deleteUserEndpointsRequest)
```
    Deletes all the endpoints that are associated with a specific user ID.
    
    Parameters:
    
    deleteUserEndpointsRequest -
    
    Returns:
    
    Result of the DeleteUserEndpoints operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - deleteVoiceChannel
```
DeleteVoiceChannelResult deleteVoiceChannel(DeleteVoiceChannelRequest deleteVoiceChannelRequest)
```
    Disables the voice channel for an application and deletes any existing settings for the channel.
    
    Parameters:
    
    deleteVoiceChannelRequest -
    
    Returns:
    
    Result of the DeleteVoiceChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - deleteVoiceTemplate
```
DeleteVoiceTemplateResult deleteVoiceTemplate(DeleteVoiceTemplateRequest deleteVoiceTemplateRequest)
```
    Deletes a message template for messages that were sent through the voice channel.
    
    Parameters:
    
    deleteVoiceTemplateRequest -
    
    Returns:
    
    Result of the DeleteVoiceTemplate operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - getAdmChannel
```
GetAdmChannelResult getAdmChannel(GetAdmChannelRequest getAdmChannelRequest)
```
    Retrieves information about the status and settings of the ADM channel for an application.
    
    Parameters:
    
    getAdmChannelRequest -
    
    Returns:
    
    Result of the GetAdmChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - getApnsChannel
```
GetApnsChannelResult getApnsChannel(GetApnsChannelRequest getApnsChannelRequest)
```
    Retrieves information about the status and settings of the APNs channel for an application.
    
    Parameters:
    
    getApnsChannelRequest -
    
    Returns:
    
    Result of the GetApnsChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - getApnsSandboxChannel
```
GetApnsSandboxChannelResult getApnsSandboxChannel(GetApnsSandboxChannelRequest getApnsSandboxChannelRequest)
```
    Retrieves information about the status and settings of the APNs sandbox channel for an application.
    
    Parameters:
    
    getApnsSandboxChannelRequest -
    
    Returns:
    
    Result of the GetApnsSandboxChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - getApnsVoipChannel
```
GetApnsVoipChannelResult getApnsVoipChannel(GetApnsVoipChannelRequest getApnsVoipChannelRequest)
```
    Retrieves information about the status and settings of the APNs VoIP channel for an application.
    
    Parameters:
    
    getApnsVoipChannelRequest -
    
    Returns:
    
    Result of the GetApnsVoipChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - getApnsVoipSandboxChannel
```
GetApnsVoipSandboxChannelResult getApnsVoipSandboxChannel(GetApnsVoipSandboxChannelRequest getApnsVoipSandboxChannelRequest)
```
    Retrieves information about the status and settings of the APNs VoIP sandbox channel for an application.
    
    Parameters:
    
    getApnsVoipSandboxChannelRequest -
    
    Returns:
    
    Result of the GetApnsVoipSandboxChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - getApp
```
GetAppResult getApp(GetAppRequest getAppRequest)
```
    Retrieves information about an application.
    
    Parameters:
    
    getAppRequest -
    
    Returns:
    
    Result of the GetApp operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - getApplicationDateRangeKpi
```
GetApplicationDateRangeKpiResult getApplicationDateRangeKpi(GetApplicationDateRangeKpiRequest getApplicationDateRangeKpiRequest)
```
    Retrieves (queries) pre-aggregated data for a standard metric that applies to an application.
    
    Parameters:
    
    getApplicationDateRangeKpiRequest -
    
    Returns:
    
    Result of the GetApplicationDateRangeKpi operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - getApplicationSettings
```
GetApplicationSettingsResult getApplicationSettings(GetApplicationSettingsRequest getApplicationSettingsRequest)
```
    Retrieves information about the settings for an application.
    
    Parameters:
    
    getApplicationSettingsRequest -
    
    Returns:
    
    Result of the GetApplicationSettings operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - getApps
```
GetAppsResult getApps(GetAppsRequest getAppsRequest)
```
    Retrieves information about all the applications that are associated with your Amazon Pinpoint account.
    
    Parameters:
    
    getAppsRequest -
    
    Returns:
    
    Result of the GetApps operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - getBaiduChannel
```
GetBaiduChannelResult getBaiduChannel(GetBaiduChannelRequest getBaiduChannelRequest)
```
    Retrieves information about the status and settings of the Baidu channel for an application.
    
    Parameters:
    
    getBaiduChannelRequest -
    
    Returns:
    
    Result of the GetBaiduChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - getCampaign
```
GetCampaignResult getCampaign(GetCampaignRequest getCampaignRequest)
```
    Retrieves information about the status, configuration, and other settings for a campaign.
    
    Parameters:
    
    getCampaignRequest -
    
    Returns:
    
    Result of the GetCampaign operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - getCampaignActivities
```
GetCampaignActivitiesResult getCampaignActivities(GetCampaignActivitiesRequest getCampaignActivitiesRequest)
```
    Retrieves information about all the activities for a campaign.
    
    Parameters:
    
    getCampaignActivitiesRequest -
    
    Returns:
    
    Result of the GetCampaignActivities operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - getCampaignDateRangeKpi
```
GetCampaignDateRangeKpiResult getCampaignDateRangeKpi(GetCampaignDateRangeKpiRequest getCampaignDateRangeKpiRequest)
```
    Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign.
    
    Parameters:
    
    getCampaignDateRangeKpiRequest -
    
    Returns:
    
    Result of the GetCampaignDateRangeKpi operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - getCampaignVersion
```
GetCampaignVersionResult getCampaignVersion(GetCampaignVersionRequest getCampaignVersionRequest)
```
    Retrieves information about the status, configuration, and other settings for a specific version of a campaign.
    
    Parameters:
    
    getCampaignVersionRequest -
    
    Returns:
    
    Result of the GetCampaignVersion operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - getCampaignVersions
```
GetCampaignVersionsResult getCampaignVersions(GetCampaignVersionsRequest getCampaignVersionsRequest)
```
    Retrieves information about the status, configuration, and other settings for all versions of a campaign.
    
    Parameters:
    
    getCampaignVersionsRequest -
    
    Returns:
    
    Result of the GetCampaignVersions operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - getCampaigns
```
GetCampaignsResult getCampaigns(GetCampaignsRequest getCampaignsRequest)
```
    Retrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application.
    
    Parameters:
    
    getCampaignsRequest -
    
    Returns:
    
    Result of the GetCampaigns operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - getChannels
```
GetChannelsResult getChannels(GetChannelsRequest getChannelsRequest)
```
    Retrieves information about the history and status of each channel for an application.
    
    Parameters:
    
    getChannelsRequest -
    
    Returns:
    
    Result of the GetChannels operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - getEmailChannel
```
GetEmailChannelResult getEmailChannel(GetEmailChannelRequest getEmailChannelRequest)
```
    Retrieves information about the status and settings of the email channel for an application.
    
    Parameters:
    
    getEmailChannelRequest -
    
    Returns:
    
    Result of the GetEmailChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - getEmailTemplate
```
GetEmailTemplateResult getEmailTemplate(GetEmailTemplateRequest getEmailTemplateRequest)
```
    Retrieves the content and settings of a message template for messages that are sent through the email channel.
    
    Parameters:
    
    getEmailTemplateRequest -
    
    Returns:
    
    Result of the GetEmailTemplate operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - getEndpoint
```
GetEndpointResult getEndpoint(GetEndpointRequest getEndpointRequest)
```
    Retrieves information about the settings and attributes of a specific endpoint for an application.
    
    Parameters:
    
    getEndpointRequest -
    
    Returns:
    
    Result of the GetEndpoint operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - getEventStream
```
GetEventStreamResult getEventStream(GetEventStreamRequest getEventStreamRequest)
```
    Retrieves information about the event stream settings for an application.
    
    Parameters:
    
    getEventStreamRequest -
    
    Returns:
    
    Result of the GetEventStream operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - getExportJob
```
GetExportJobResult getExportJob(GetExportJobRequest getExportJobRequest)
```
    Retrieves information about the status and settings of a specific export job for an application.
    
    Parameters:
    
    getExportJobRequest -
    
    Returns:
    
    Result of the GetExportJob operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - getExportJobs
```
GetExportJobsResult getExportJobs(GetExportJobsRequest getExportJobsRequest)
```
    Retrieves information about the status and settings of all the export jobs for an application.
    
    Parameters:
    
    getExportJobsRequest -
    
    Returns:
    
    Result of the GetExportJobs operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - getGcmChannel
```
GetGcmChannelResult getGcmChannel(GetGcmChannelRequest getGcmChannelRequest)
```
    Retrieves information about the status and settings of the GCM channel for an application.
    
    Parameters:
    
    getGcmChannelRequest -
    
    Returns:
    
    Result of the GetGcmChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - getImportJob
```
GetImportJobResult getImportJob(GetImportJobRequest getImportJobRequest)
```
    Retrieves information about the status and settings of a specific import job for an application.
    
    Parameters:
    
    getImportJobRequest -
    
    Returns:
    
    Result of the GetImportJob operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - getImportJobs
```
GetImportJobsResult getImportJobs(GetImportJobsRequest getImportJobsRequest)
```
    Retrieves information about the status and settings of all the import jobs for an application.
    
    Parameters:
    
    getImportJobsRequest -
    
    Returns:
    
    Result of the GetImportJobs operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - getInAppMessages
```
GetInAppMessagesResult getInAppMessages(GetInAppMessagesRequest getInAppMessagesRequest)
```
    Retrieves the in-app messages targeted for the provided endpoint ID.
    
    Parameters:
    
    getInAppMessagesRequest -
    
    Returns:
    
    Result of the GetInAppMessages operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - getInAppTemplate
```
GetInAppTemplateResult getInAppTemplate(GetInAppTemplateRequest getInAppTemplateRequest)
```
    Retrieves the content and settings of a message template for messages sent through the in-app channel.
    
    Parameters:
    
    getInAppTemplateRequest -
    
    Returns:
    
    Result of the GetInAppTemplate operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - getJourney
```
GetJourneyResult getJourney(GetJourneyRequest getJourneyRequest)
```
    Retrieves information about the status, configuration, and other settings for a journey.
    
    Parameters:
    
    getJourneyRequest -
    
    Returns:
    
    Result of the GetJourney operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - getJourneyDateRangeKpi
```
GetJourneyDateRangeKpiResult getJourneyDateRangeKpi(GetJourneyDateRangeKpiRequest getJourneyDateRangeKpiRequest)
```
    Retrieves (queries) pre-aggregated data for a standard engagement metric that applies to a journey.
    
    Parameters:
    
    getJourneyDateRangeKpiRequest -
    
    Returns:
    
    Result of the GetJourneyDateRangeKpi operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - getJourneyExecutionActivityMetrics
```
GetJourneyExecutionActivityMetricsResult getJourneyExecutionActivityMetrics(GetJourneyExecutionActivityMetricsRequest getJourneyExecutionActivityMetricsRequest)
```
    Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey activity.
    
    Parameters:
    
    getJourneyExecutionActivityMetricsRequest -
    
    Returns:
    
    Result of the GetJourneyExecutionActivityMetrics operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - getJourneyExecutionMetrics
```
GetJourneyExecutionMetricsResult getJourneyExecutionMetrics(GetJourneyExecutionMetricsRequest getJourneyExecutionMetricsRequest)
```
    Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey.
    
    Parameters:
    
    getJourneyExecutionMetricsRequest -
    
    Returns:
    
    Result of the GetJourneyExecutionMetrics operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - getPushTemplate
```
GetPushTemplateResult getPushTemplate(GetPushTemplateRequest getPushTemplateRequest)
```
    Retrieves the content and settings of a message template for messages that are sent through a push notification channel.
    
    Parameters:
    
    getPushTemplateRequest -
    
    Returns:
    
    Result of the GetPushTemplate operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - getRecommenderConfiguration
```
GetRecommenderConfigurationResult getRecommenderConfiguration(GetRecommenderConfigurationRequest getRecommenderConfigurationRequest)
```
    Retrieves information about an Amazon Pinpoint configuration for a recommender model.
    
    Parameters:
    
    getRecommenderConfigurationRequest -
    
    Returns:
    
    Result of the GetRecommenderConfiguration operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - getRecommenderConfigurations
```
GetRecommenderConfigurationsResult getRecommenderConfigurations(GetRecommenderConfigurationsRequest getRecommenderConfigurationsRequest)
```
    Retrieves information about all the recommender model configurations that are associated with your Amazon Pinpoint account.
    
    Parameters:
    
    getRecommenderConfigurationsRequest -
    
    Returns:
    
    Result of the GetRecommenderConfigurations operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - getSegment
```
GetSegmentResult getSegment(GetSegmentRequest getSegmentRequest)
```
    Retrieves information about the configuration, dimension, and other settings for a specific segment that's associated with an application.
    
    Parameters:
    
    getSegmentRequest -
    
    Returns:
    
    Result of the GetSegment operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - getSegmentExportJobs
```
GetSegmentExportJobsResult getSegmentExportJobs(GetSegmentExportJobsRequest getSegmentExportJobsRequest)
```
    Retrieves information about the status and settings of the export jobs for a segment.
    
    Parameters:
    
    getSegmentExportJobsRequest -
    
    Returns:
    
    Result of the GetSegmentExportJobs operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - getSegmentImportJobs
```
GetSegmentImportJobsResult getSegmentImportJobs(GetSegmentImportJobsRequest getSegmentImportJobsRequest)
```
    Retrieves information about the status and settings of the import jobs for a segment.
    
    Parameters:
    
    getSegmentImportJobsRequest -
    
    Returns:
    
    Result of the GetSegmentImportJobs operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - getSegmentVersion
```
GetSegmentVersionResult getSegmentVersion(GetSegmentVersionRequest getSegmentVersionRequest)
```
    Retrieves information about the configuration, dimension, and other settings for a specific version of a segment that's associated with an application.
    
    Parameters:
    
    getSegmentVersionRequest -
    
    Returns:
    
    Result of the GetSegmentVersion operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - getSegmentVersions
```
GetSegmentVersionsResult getSegmentVersions(GetSegmentVersionsRequest getSegmentVersionsRequest)
```
    Retrieves information about the configuration, dimension, and other settings for all the versions of a specific segment that's associated with an application.
    
    Parameters:
    
    getSegmentVersionsRequest -
    
    Returns:
    
    Result of the GetSegmentVersions operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - getSegments
```
GetSegmentsResult getSegments(GetSegmentsRequest getSegmentsRequest)
```
    Retrieves information about the configuration, dimension, and other settings for all the segments that are associated with an application.
    
    Parameters:
    
    getSegmentsRequest -
    
    Returns:
    
    Result of the GetSegments operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - getSmsChannel
```
GetSmsChannelResult getSmsChannel(GetSmsChannelRequest getSmsChannelRequest)
```
    Retrieves information about the status and settings of the SMS channel for an application.
    
    Parameters:
    
    getSmsChannelRequest -
    
    Returns:
    
    Result of the GetSmsChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - getSmsTemplate
```
GetSmsTemplateResult getSmsTemplate(GetSmsTemplateRequest getSmsTemplateRequest)
```
    Retrieves the content and settings of a message template for messages that are sent through the SMS channel.
    
    Parameters:
    
    getSmsTemplateRequest -
    
    Returns:
    
    Result of the GetSmsTemplate operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - getUserEndpoints
```
GetUserEndpointsResult getUserEndpoints(GetUserEndpointsRequest getUserEndpointsRequest)
```
    Retrieves information about all the endpoints that are associated with a specific user ID.
    
    Parameters:
    
    getUserEndpointsRequest -
    
    Returns:
    
    Result of the GetUserEndpoints operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - getVoiceChannel
```
GetVoiceChannelResult getVoiceChannel(GetVoiceChannelRequest getVoiceChannelRequest)
```
    Retrieves information about the status and settings of the voice channel for an application.
    
    Parameters:
    
    getVoiceChannelRequest -
    
    Returns:
    
    Result of the GetVoiceChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - getVoiceTemplate
```
GetVoiceTemplateResult getVoiceTemplate(GetVoiceTemplateRequest getVoiceTemplateRequest)
```
    Retrieves the content and settings of a message template for messages that are sent through the voice channel.
    
    Parameters:
    
    getVoiceTemplateRequest -
    
    Returns:
    
    Result of the GetVoiceTemplate operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - listJourneys
```
ListJourneysResult listJourneys(ListJourneysRequest listJourneysRequest)
```
    Retrieves information about the status, configuration, and other settings for all the journeys that are associated with an application.
    
    Parameters:
    
    listJourneysRequest -
    
    Returns:
    
    Result of the ListJourneys operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
```
    Retrieves all the tags (keys and values) that are associated with an application, campaign, message template, or segment.
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTemplateVersions
```
ListTemplateVersionsResult listTemplateVersions(ListTemplateVersionsRequest listTemplateVersionsRequest)
```
    Retrieves information about all the versions of a specific message template.
    
    Parameters:
    
    listTemplateVersionsRequest -
    
    Returns:
    
    Result of the ListTemplateVersions operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - listTemplates
```
ListTemplatesResult listTemplates(ListTemplatesRequest listTemplatesRequest)
```
    Retrieves information about all the message templates that are associated with your Amazon Pinpoint account.
    
    Parameters:
    
    listTemplatesRequest -
    
    Returns:
    
    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).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    See Also:
    
    AWS API Documentation
  - phoneNumberValidate
```
PhoneNumberValidateResult phoneNumberValidate(PhoneNumberValidateRequest phoneNumberValidateRequest)
```
    Retrieves information about a phone number.
    
    Parameters:
    
    phoneNumberValidateRequest -
    
    Returns:
    
    Result of the PhoneNumberValidate operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - putEventStream
```
PutEventStreamResult putEventStream(PutEventStreamRequest putEventStreamRequest)
```
    Creates a new event stream for an application or updates the settings of an existing event stream for an application.
    
    Parameters:
    
    putEventStreamRequest -
    
    Returns:
    
    Result of the PutEventStream operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - putEvents
```
PutEventsResult putEvents(PutEventsRequest putEventsRequest)
```
    Creates a new event to record for endpoints, or creates or updates endpoint data that existing events are associated with.
    
    Parameters:
    
    putEventsRequest -
    
    Returns:
    
    Result of the PutEvents operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - removeAttributes
```
RemoveAttributesResult removeAttributes(RemoveAttributesRequest removeAttributesRequest)
```
    Removes one or more attributes, of the same attribute type, from all the endpoints that are associated with an application.
    
    Parameters:
    
    removeAttributesRequest -
    
    Returns:
    
    Result of the RemoveAttributes operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - sendMessages
```
SendMessagesResult sendMessages(SendMessagesRequest sendMessagesRequest)
```
    Creates and sends a direct message.
    
    Parameters:
    
    sendMessagesRequest -
    
    Returns:
    
    Result of the SendMessages operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - sendOTPMessage
```
SendOTPMessageResult sendOTPMessage(SendOTPMessageRequest sendOTPMessageRequest)
```
    Send an OTP message
    
    Parameters:
    
    sendOTPMessageRequest -
    
    Returns:
    
    Result of the SendOTPMessage operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    PayloadTooLargeException - 413 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - sendUsersMessages
```
SendUsersMessagesResult sendUsersMessages(SendUsersMessagesRequest sendUsersMessagesRequest)
```
    Creates and sends a message to a list of users.
    
    Parameters:
    
    sendUsersMessagesRequest -
    
    Returns:
    
    Result of the SendUsersMessages operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
```
    Adds one or more tags (keys and values) to an application, campaign, message template, or segment.
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
```
    Removes one or more tags (keys and values) from an application, campaign, message template, or segment.
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateAdmChannel
```
UpdateAdmChannelResult updateAdmChannel(UpdateAdmChannelRequest updateAdmChannelRequest)
```
    Enables the ADM channel for an application or updates the status and settings of the ADM channel for an application.
    
    Parameters:
    
    updateAdmChannelRequest -
    
    Returns:
    
    Result of the UpdateAdmChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - updateApnsChannel
```
UpdateApnsChannelResult updateApnsChannel(UpdateApnsChannelRequest updateApnsChannelRequest)
```
    Enables the APNs channel for an application or updates the status and settings of the APNs channel for an application.
    
    Parameters:
    
    updateApnsChannelRequest -
    
    Returns:
    
    Result of the UpdateApnsChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - updateApnsSandboxChannel
```
UpdateApnsSandboxChannelResult updateApnsSandboxChannel(UpdateApnsSandboxChannelRequest updateApnsSandboxChannelRequest)
```
    Enables the APNs sandbox channel for an application or updates the status and settings of the APNs sandbox channel for an application.
    
    Parameters:
    
    updateApnsSandboxChannelRequest -
    
    Returns:
    
    Result of the UpdateApnsSandboxChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - updateApnsVoipChannel
```
UpdateApnsVoipChannelResult updateApnsVoipChannel(UpdateApnsVoipChannelRequest updateApnsVoipChannelRequest)
```
    Enables the APNs VoIP channel for an application or updates the status and settings of the APNs VoIP channel for an application.
    
    Parameters:
    
    updateApnsVoipChannelRequest -
    
    Returns:
    
    Result of the UpdateApnsVoipChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - updateApnsVoipSandboxChannel
```
UpdateApnsVoipSandboxChannelResult updateApnsVoipSandboxChannel(UpdateApnsVoipSandboxChannelRequest updateApnsVoipSandboxChannelRequest)
```
    Enables the APNs VoIP sandbox channel for an application or updates the status and settings of the APNs VoIP sandbox channel for an application.
    
    Parameters:
    
    updateApnsVoipSandboxChannelRequest -
    
    Returns:
    
    Result of the UpdateApnsVoipSandboxChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - updateApplicationSettings
```
UpdateApplicationSettingsResult updateApplicationSettings(UpdateApplicationSettingsRequest updateApplicationSettingsRequest)
```
    Updates the settings for an application.
    
    Parameters:
    
    updateApplicationSettingsRequest -
    
    Returns:
    
    Result of the UpdateApplicationSettings operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - updateBaiduChannel
```
UpdateBaiduChannelResult updateBaiduChannel(UpdateBaiduChannelRequest updateBaiduChannelRequest)
```
    Enables the Baidu channel for an application or updates the status and settings of the Baidu channel for an application.
    
    Parameters:
    
    updateBaiduChannelRequest -
    
    Returns:
    
    Result of the UpdateBaiduChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - updateCampaign
```
UpdateCampaignResult updateCampaign(UpdateCampaignRequest updateCampaignRequest)
```
    Updates the configuration and other settings for a campaign.
    
    Parameters:
    
    updateCampaignRequest -
    
    Returns:
    
    Result of the UpdateCampaign operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - updateEmailChannel
```
UpdateEmailChannelResult updateEmailChannel(UpdateEmailChannelRequest updateEmailChannelRequest)
```
    Enables the email channel for an application or updates the status and settings of the email channel for an application.
    
    Parameters:
    
    updateEmailChannelRequest -
    
    Returns:
    
    Result of the UpdateEmailChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - updateEmailTemplate
```
UpdateEmailTemplateResult updateEmailTemplate(UpdateEmailTemplateRequest updateEmailTemplateRequest)
```
    Updates an existing message template for messages that are sent through the email channel.
    
    Parameters:
    
    updateEmailTemplateRequest -
    
    Returns:
    
    Result of the UpdateEmailTemplate operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - updateEndpoint
```
UpdateEndpointResult updateEndpoint(UpdateEndpointRequest updateEndpointRequest)
```
    Creates a new endpoint for an application or updates the settings and attributes of an existing endpoint for an application. You can also use this operation to define custom attributes for an endpoint. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values.
    
    Parameters:
    
    updateEndpointRequest -
    
    Returns:
    
    Result of the UpdateEndpoint operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - updateEndpointsBatch
```
UpdateEndpointsBatchResult updateEndpointsBatch(UpdateEndpointsBatchRequest updateEndpointsBatchRequest)
```
    Creates a new batch of endpoints for an application or updates the settings and attributes of a batch of existing endpoints for an application. You can also use this operation to define custom attributes for a batch of endpoints. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values.
    
    Parameters:
    
    updateEndpointsBatchRequest -
    
    Returns:
    
    Result of the UpdateEndpointsBatch operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - updateGcmChannel
```
UpdateGcmChannelResult updateGcmChannel(UpdateGcmChannelRequest updateGcmChannelRequest)
```
    Enables the GCM channel for an application or updates the status and settings of the GCM channel for an application.
    
    Parameters:
    
    updateGcmChannelRequest -
    
    Returns:
    
    Result of the UpdateGcmChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - updateInAppTemplate
```
UpdateInAppTemplateResult updateInAppTemplate(UpdateInAppTemplateRequest updateInAppTemplateRequest)
```
    Updates an existing message template for messages sent through the in-app message channel.
    
    Parameters:
    
    updateInAppTemplateRequest -
    
    Returns:
    
    Result of the UpdateInAppTemplate operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - updateJourney
```
UpdateJourneyResult updateJourney(UpdateJourneyRequest updateJourneyRequest)
```
    Updates the configuration and other settings for a journey.
    
    Parameters:
    
    updateJourneyRequest -
    
    Returns:
    
    Result of the UpdateJourney operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    ConflictException - The request failed due to a conflict with the current state of the specified resource (ConflictException).
    
    See Also:
    
    AWS API Documentation
  - updateJourneyState
```
UpdateJourneyStateResult updateJourneyState(UpdateJourneyStateRequest updateJourneyStateRequest)
```
    Cancels (stops) an active journey.
    
    Parameters:
    
    updateJourneyStateRequest -
    
    Returns:
    
    Result of the UpdateJourneyState operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - updatePushTemplate
```
UpdatePushTemplateResult updatePushTemplate(UpdatePushTemplateRequest updatePushTemplateRequest)
```
    Updates an existing message template for messages that are sent through a push notification channel.
    
    Parameters:
    
    updatePushTemplateRequest -
    
    Returns:
    
    Result of the UpdatePushTemplate operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - updateRecommenderConfiguration
```
UpdateRecommenderConfigurationResult updateRecommenderConfiguration(UpdateRecommenderConfigurationRequest updateRecommenderConfigurationRequest)
```
    Updates an Amazon Pinpoint configuration for a recommender model.
    
    Parameters:
    
    updateRecommenderConfigurationRequest -
    
    Returns:
    
    Result of the UpdateRecommenderConfiguration operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - updateSegment
```
UpdateSegmentResult updateSegment(UpdateSegmentRequest updateSegmentRequest)
```
    Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.
    
    Parameters:
    
    updateSegmentRequest -
    
    Returns:
    
    Result of the UpdateSegment operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - updateSmsChannel
```
UpdateSmsChannelResult updateSmsChannel(UpdateSmsChannelRequest updateSmsChannelRequest)
```
    Enables the SMS channel for an application or updates the status and settings of the SMS channel for an application.
    
    Parameters:
    
    updateSmsChannelRequest -
    
    Returns:
    
    Result of the UpdateSmsChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - updateSmsTemplate
```
UpdateSmsTemplateResult updateSmsTemplate(UpdateSmsTemplateRequest updateSmsTemplateRequest)
```
    Updates an existing message template for messages that are sent through the SMS channel.
    
    Parameters:
    
    updateSmsTemplateRequest -
    
    Returns:
    
    Result of the UpdateSmsTemplate operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - updateTemplateActiveVersion
```
UpdateTemplateActiveVersionResult updateTemplateActiveVersion(UpdateTemplateActiveVersionRequest updateTemplateActiveVersionRequest)
```
    Changes the status of a specific version of a message template to active.
    
    Parameters:
    
    updateTemplateActiveVersionRequest -
    
    Returns:
    
    Result of the UpdateTemplateActiveVersion operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - updateVoiceChannel
```
UpdateVoiceChannelResult updateVoiceChannel(UpdateVoiceChannelRequest updateVoiceChannelRequest)
```
    Enables the voice channel for an application or updates the status and settings of the voice channel for an application.
    
    Parameters:
    
    updateVoiceChannelRequest -
    
    Returns:
    
    Result of the UpdateVoiceChannel operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - updateVoiceTemplate
```
UpdateVoiceTemplateResult updateVoiceTemplate(UpdateVoiceTemplateRequest updateVoiceTemplateRequest)
```
    Updates an existing message template for messages that are sent through the voice channel.
    
    Parameters:
    
    updateVoiceTemplateRequest -
    
    Returns:
    
    Result of the UpdateVoiceTemplate operation returned by the service.
    
    Throws:
    
    BadRequestException - The request contains a syntax error (BadRequestException).
    
    InternalServerErrorException - The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).
    
    PayloadTooLargeException - The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
    
    TooManyRequestsException - The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
    
    See Also:
    
    AWS API Documentation
  - verifyOTPMessage
```
VerifyOTPMessageResult verifyOTPMessage(VerifyOTPMessageRequest verifyOTPMessageRequest)
```
    Verify an OTP
    
    Parameters:
    
    verifyOTPMessageRequest -
    
    Returns:
    
    Result of the VerifyOTPMessage operation returned by the service.
    
    Throws:
    
    BadRequestException - 400 response
    
    InternalServerErrorException - 500 response
    
    PayloadTooLargeException - 413 response
    
    ForbiddenException - 403 response
    
    NotFoundException - 404 response
    
    MethodNotAllowedException - 405 response
    
    TooManyRequestsException - 429 response
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    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.
  - getCachedResponseMetadata
```
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. 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.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Interface AmazonPinpoint

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

setEndpoint

setRegion

createApp

createCampaign

createEmailTemplate

createExportJob

createImportJob

createInAppTemplate

createJourney

createPushTemplate

createRecommenderConfiguration

createSegment

createSmsTemplate

createVoiceTemplate

deleteAdmChannel

deleteApnsChannel

deleteApnsSandboxChannel

deleteApnsVoipChannel

deleteApnsVoipSandboxChannel

deleteApp

deleteBaiduChannel

deleteCampaign

deleteEmailChannel

deleteEmailTemplate

deleteEndpoint

deleteEventStream

deleteGcmChannel

deleteInAppTemplate

deleteJourney

deletePushTemplate

deleteRecommenderConfiguration

deleteSegment

deleteSmsChannel

deleteSmsTemplate

deleteUserEndpoints

deleteVoiceChannel

deleteVoiceTemplate

getAdmChannel

getApnsChannel

getApnsSandboxChannel

getApnsVoipChannel

getApnsVoipSandboxChannel

getApp

getApplicationDateRangeKpi

getApplicationSettings

getApps

getBaiduChannel

getCampaign

getCampaignActivities

getCampaignDateRangeKpi

getCampaignVersion

getCampaignVersions

getCampaigns

getChannels

getEmailChannel

getEmailTemplate

getEndpoint

getEventStream

getExportJob

getExportJobs

getGcmChannel

getImportJob

getImportJobs

getInAppMessages

getInAppTemplate

getJourney

getJourneyDateRangeKpi

getJourneyExecutionActivityMetrics

getJourneyExecutionMetrics

getPushTemplate

getRecommenderConfiguration

getRecommenderConfigurations

getSegment