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.
`CreateExportJobResult`	`createExportJob(CreateExportJobRequest createExportJobRequest)` Creates a new export job for an application.
`CreateImportJobResult`	`createImportJob(CreateImportJobRequest createImportJobRequest)` Creates a new import job for an application.
`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.
`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.
`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.
`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.
`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.
`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 of your applications.
`GetBaiduChannelResult`	`getBaiduChannel(GetBaiduChannelRequest getBaiduChannelRequest)` Retrieves information about the status and settings of the Baidu Cloud Push 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 the activity performed by 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 specific 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.
`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.
`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 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.
`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.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)` Retrieves all the tags (keys and values) that are associated with an application, campaign, or segment.
`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.
`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, or segment.
`UntagResourceResult`	`untagResource(UntagResourceRequest untagResourceRequest)` Removes one or more tags (keys and values) from an application, campaign, or segment.
`UpdateAdmChannelResult`	`updateAdmChannel(UpdateAdmChannelRequest updateAdmChannelRequest)` Updates the ADM channel settings for an application.
`UpdateApnsChannelResult`	`updateApnsChannel(UpdateApnsChannelRequest updateApnsChannelRequest)` Updates the APNs channel settings for an application.
`UpdateApnsSandboxChannelResult`	`updateApnsSandboxChannel(UpdateApnsSandboxChannelRequest updateApnsSandboxChannelRequest)` Updates the APNs sandbox channel settings for an application.
`UpdateApnsVoipChannelResult`	`updateApnsVoipChannel(UpdateApnsVoipChannelRequest updateApnsVoipChannelRequest)` Updates the APNs VoIP channel settings for an application.
`UpdateApnsVoipSandboxChannelResult`	`updateApnsVoipSandboxChannel(UpdateApnsVoipSandboxChannelRequest updateApnsVoipSandboxChannelRequest)` Updates the settings for the APNs VoIP sandbox channel for an application.
`UpdateApplicationSettingsResult`	`updateApplicationSettings(UpdateApplicationSettingsRequest updateApplicationSettingsRequest)` Updates the settings for an application.
`UpdateBaiduChannelResult`	`updateBaiduChannel(UpdateBaiduChannelRequest updateBaiduChannelRequest)` Updates the settings of the Baidu channel for an application.
`UpdateCampaignResult`	`updateCampaign(UpdateCampaignRequest updateCampaignRequest)` Updates the settings for a campaign.
`UpdateEmailChannelResult`	`updateEmailChannel(UpdateEmailChannelRequest updateEmailChannelRequest)` Updates the status and settings of the email channel for an application.
`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)` Updates the status and settings of the GCM channel for an application.
`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)` Updates the status and settings of the SMS channel for an application.
`UpdateVoiceChannelResult`	`updateVoiceChannel(UpdateVoiceChannelRequest updateVoiceChannelRequest)` Updates the status and settings of the voice channel for an application.

- 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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
  - createExportJob
```
CreateExportJobResult createExportJob(CreateExportJobRequest createExportJobRequest)
```
    Creates a new 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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 a new 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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
  - 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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 of your applications.
    
    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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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 Cloud Push 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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 the activity performed by 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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 specific 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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, or segment.
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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
  - 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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, 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, or segment.
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateAdmChannel
```
UpdateAdmChannelResult updateAdmChannel(UpdateAdmChannelRequest updateAdmChannelRequest)
```
    Updates the ADM channel settings 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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)
```
    Updates the APNs channel settings 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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)
```
    Updates the APNs sandbox channel settings 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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)
```
    Updates the APNs VoIP channel settings 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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)
```
    Updates the settings for 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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)
```
    Updates the 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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)
```
    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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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 (Attributes, Metrics, and UserAttributes properties) for an endpoint.
    
    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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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 (Attributes, Metrics, and UserAttributes properties) for a batch of endpoints.
    
    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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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)
```
    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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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)
```
    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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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)
```
    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).
    
    ForbiddenException - The request was denied because access to the specified resource is forbidden (ForbiddenException).
    
    NotFoundException - The request failed because the specified resource was not found (NotFoundException).
    
    MethodNotAllowedException - The request failed because the method is 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
  - 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

createExportJob

createImportJob

createSegment

deleteAdmChannel

deleteApnsChannel

deleteApnsSandboxChannel

deleteApnsVoipChannel

deleteApnsVoipSandboxChannel

deleteApp

deleteBaiduChannel

deleteCampaign

deleteEmailChannel

deleteEndpoint

deleteEventStream

deleteGcmChannel

deleteSegment

deleteSmsChannel

deleteUserEndpoints

deleteVoiceChannel

getAdmChannel

getApnsChannel

getApnsSandboxChannel

getApnsVoipChannel

getApnsVoipSandboxChannel

getApp

getApplicationDateRangeKpi

getApplicationSettings

getApps

getBaiduChannel

getCampaign

getCampaignActivities

getCampaignDateRangeKpi

getCampaignVersion

getCampaignVersions

getCampaigns

getChannels

getEmailChannel

getEndpoint

getEventStream

getExportJob

getExportJobs

getGcmChannel

getImportJob

getImportJobs

getSegment

getSegmentExportJobs

getSegmentImportJobs

getSegmentVersion

getSegmentVersions

getSegments

getSmsChannel

getUserEndpoints

getVoiceChannel

listTagsForResource

phoneNumberValidate

putEventStream

putEvents

removeAttributes

sendMessages

sendUsersMessages

tagResource

untagResource

updateAdmChannel

updateApnsChannel

updateApnsSandboxChannel

updateApnsVoipChannel

updateApnsVoipSandboxChannel

updateApplicationSettings

updateBaiduChannel