Interface PinpointClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
builder() method.
Doc Engage API - Amazon Pinpoint API
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptionstatic PinpointClientBuilderbuilder()Create a builder that can be used to configure and create aPinpointClient.static PinpointClientcreate()Create aPinpointClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateAppResponsecreateApp(Consumer<CreateAppRequest.Builder> createAppRequest) Creates an application.default CreateAppResponsecreateApp(CreateAppRequest createAppRequest) Creates an application.default CreateCampaignResponsecreateCampaign(Consumer<CreateCampaignRequest.Builder> createCampaignRequest) Creates a new campaign for an application or updates the settings of an existing campaign for an application.default CreateCampaignResponsecreateCampaign(CreateCampaignRequest createCampaignRequest) Creates a new campaign for an application or updates the settings of an existing campaign for an application.default CreateEmailTemplateResponsecreateEmailTemplate(Consumer<CreateEmailTemplateRequest.Builder> createEmailTemplateRequest) Creates a message template for messages that are sent through the email channel.default CreateEmailTemplateResponsecreateEmailTemplate(CreateEmailTemplateRequest createEmailTemplateRequest) Creates a message template for messages that are sent through the email channel.default CreateExportJobResponsecreateExportJob(Consumer<CreateExportJobRequest.Builder> createExportJobRequest) Creates an export job for an application.default CreateExportJobResponsecreateExportJob(CreateExportJobRequest createExportJobRequest) Creates an export job for an application.default CreateImportJobResponsecreateImportJob(Consumer<CreateImportJobRequest.Builder> createImportJobRequest) Creates an import job for an application.default CreateImportJobResponsecreateImportJob(CreateImportJobRequest createImportJobRequest) Creates an import job for an application.default CreateInAppTemplateResponsecreateInAppTemplate(Consumer<CreateInAppTemplateRequest.Builder> createInAppTemplateRequest) Creates a new message template for messages using the in-app message channel.default CreateInAppTemplateResponsecreateInAppTemplate(CreateInAppTemplateRequest createInAppTemplateRequest) Creates a new message template for messages using the in-app message channel.default CreateJourneyResponsecreateJourney(Consumer<CreateJourneyRequest.Builder> createJourneyRequest) Creates a journey for an application.default CreateJourneyResponsecreateJourney(CreateJourneyRequest createJourneyRequest) Creates a journey for an application.default CreatePushTemplateResponsecreatePushTemplate(Consumer<CreatePushTemplateRequest.Builder> createPushTemplateRequest) Creates a message template for messages that are sent through a push notification channel.default CreatePushTemplateResponsecreatePushTemplate(CreatePushTemplateRequest createPushTemplateRequest) Creates a message template for messages that are sent through a push notification channel.createRecommenderConfiguration(Consumer<CreateRecommenderConfigurationRequest.Builder> createRecommenderConfigurationRequest) Creates an Amazon Pinpoint configuration for a recommender model.createRecommenderConfiguration(CreateRecommenderConfigurationRequest createRecommenderConfigurationRequest) Creates an Amazon Pinpoint configuration for a recommender model.default CreateSegmentResponsecreateSegment(Consumer<CreateSegmentRequest.Builder> 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.default CreateSegmentResponsecreateSegment(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.default CreateSmsTemplateResponsecreateSmsTemplate(Consumer<CreateSmsTemplateRequest.Builder> createSmsTemplateRequest) Creates a message template for messages that are sent through the SMS channel.default CreateSmsTemplateResponsecreateSmsTemplate(CreateSmsTemplateRequest createSmsTemplateRequest) Creates a message template for messages that are sent through the SMS channel.default CreateVoiceTemplateResponsecreateVoiceTemplate(Consumer<CreateVoiceTemplateRequest.Builder> createVoiceTemplateRequest) Creates a message template for messages that are sent through the voice channel.default CreateVoiceTemplateResponsecreateVoiceTemplate(CreateVoiceTemplateRequest createVoiceTemplateRequest) Creates a message template for messages that are sent through the voice channel.default DeleteAdmChannelResponsedeleteAdmChannel(Consumer<DeleteAdmChannelRequest.Builder> deleteAdmChannelRequest) Disables the ADM channel for an application and deletes any existing settings for the channel.default DeleteAdmChannelResponsedeleteAdmChannel(DeleteAdmChannelRequest deleteAdmChannelRequest) Disables the ADM channel for an application and deletes any existing settings for the channel.default DeleteApnsChannelResponsedeleteApnsChannel(Consumer<DeleteApnsChannelRequest.Builder> deleteApnsChannelRequest) Disables the APNs channel for an application and deletes any existing settings for the channel.default DeleteApnsChannelResponsedeleteApnsChannel(DeleteApnsChannelRequest deleteApnsChannelRequest) Disables the APNs channel for an application and deletes any existing settings for the channel.default DeleteApnsSandboxChannelResponsedeleteApnsSandboxChannel(Consumer<DeleteApnsSandboxChannelRequest.Builder> deleteApnsSandboxChannelRequest) Disables the APNs sandbox channel for an application and deletes any existing settings for the channel.default DeleteApnsSandboxChannelResponsedeleteApnsSandboxChannel(DeleteApnsSandboxChannelRequest deleteApnsSandboxChannelRequest) Disables the APNs sandbox channel for an application and deletes any existing settings for the channel.default DeleteApnsVoipChannelResponsedeleteApnsVoipChannel(Consumer<DeleteApnsVoipChannelRequest.Builder> deleteApnsVoipChannelRequest) Disables the APNs VoIP channel for an application and deletes any existing settings for the channel.default DeleteApnsVoipChannelResponsedeleteApnsVoipChannel(DeleteApnsVoipChannelRequest deleteApnsVoipChannelRequest) Disables the APNs VoIP channel for an application and deletes any existing settings for the channel.deleteApnsVoipSandboxChannel(Consumer<DeleteApnsVoipSandboxChannelRequest.Builder> deleteApnsVoipSandboxChannelRequest) Disables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel.deleteApnsVoipSandboxChannel(DeleteApnsVoipSandboxChannelRequest deleteApnsVoipSandboxChannelRequest) Disables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel.default DeleteAppResponsedeleteApp(Consumer<DeleteAppRequest.Builder> deleteAppRequest) Deletes an application.default DeleteAppResponsedeleteApp(DeleteAppRequest deleteAppRequest) Deletes an application.default DeleteBaiduChannelResponsedeleteBaiduChannel(Consumer<DeleteBaiduChannelRequest.Builder> deleteBaiduChannelRequest) Disables the Baidu channel for an application and deletes any existing settings for the channel.default DeleteBaiduChannelResponsedeleteBaiduChannel(DeleteBaiduChannelRequest deleteBaiduChannelRequest) Disables the Baidu channel for an application and deletes any existing settings for the channel.default DeleteCampaignResponsedeleteCampaign(Consumer<DeleteCampaignRequest.Builder> deleteCampaignRequest) Deletes a campaign from an application.default DeleteCampaignResponsedeleteCampaign(DeleteCampaignRequest deleteCampaignRequest) Deletes a campaign from an application.default DeleteEmailChannelResponsedeleteEmailChannel(Consumer<DeleteEmailChannelRequest.Builder> deleteEmailChannelRequest) Disables the email channel for an application and deletes any existing settings for the channel.default DeleteEmailChannelResponsedeleteEmailChannel(DeleteEmailChannelRequest deleteEmailChannelRequest) Disables the email channel for an application and deletes any existing settings for the channel.default DeleteEmailTemplateResponsedeleteEmailTemplate(Consumer<DeleteEmailTemplateRequest.Builder> deleteEmailTemplateRequest) Deletes a message template for messages that were sent through the email channel.default DeleteEmailTemplateResponsedeleteEmailTemplate(DeleteEmailTemplateRequest deleteEmailTemplateRequest) Deletes a message template for messages that were sent through the email channel.default DeleteEndpointResponsedeleteEndpoint(Consumer<DeleteEndpointRequest.Builder> deleteEndpointRequest) Deletes an endpoint from an application.default DeleteEndpointResponsedeleteEndpoint(DeleteEndpointRequest deleteEndpointRequest) Deletes an endpoint from an application.default DeleteEventStreamResponsedeleteEventStream(Consumer<DeleteEventStreamRequest.Builder> deleteEventStreamRequest) Deletes the event stream for an application.default DeleteEventStreamResponsedeleteEventStream(DeleteEventStreamRequest deleteEventStreamRequest) Deletes the event stream for an application.default DeleteGcmChannelResponsedeleteGcmChannel(Consumer<DeleteGcmChannelRequest.Builder> deleteGcmChannelRequest) Disables the GCM channel for an application and deletes any existing settings for the channel.default DeleteGcmChannelResponsedeleteGcmChannel(DeleteGcmChannelRequest deleteGcmChannelRequest) Disables the GCM channel for an application and deletes any existing settings for the channel.default DeleteInAppTemplateResponsedeleteInAppTemplate(Consumer<DeleteInAppTemplateRequest.Builder> deleteInAppTemplateRequest) Deletes a message template for messages sent using the in-app message channel.default DeleteInAppTemplateResponsedeleteInAppTemplate(DeleteInAppTemplateRequest deleteInAppTemplateRequest) Deletes a message template for messages sent using the in-app message channel.default DeleteJourneyResponsedeleteJourney(Consumer<DeleteJourneyRequest.Builder> deleteJourneyRequest) Deletes a journey from an application.default DeleteJourneyResponsedeleteJourney(DeleteJourneyRequest deleteJourneyRequest) Deletes a journey from an application.default DeletePushTemplateResponsedeletePushTemplate(Consumer<DeletePushTemplateRequest.Builder> deletePushTemplateRequest) Deletes a message template for messages that were sent through a push notification channel.default DeletePushTemplateResponsedeletePushTemplate(DeletePushTemplateRequest deletePushTemplateRequest) Deletes a message template for messages that were sent through a push notification channel.deleteRecommenderConfiguration(Consumer<DeleteRecommenderConfigurationRequest.Builder> deleteRecommenderConfigurationRequest) Deletes an Amazon Pinpoint configuration for a recommender model.deleteRecommenderConfiguration(DeleteRecommenderConfigurationRequest deleteRecommenderConfigurationRequest) Deletes an Amazon Pinpoint configuration for a recommender model.default DeleteSegmentResponsedeleteSegment(Consumer<DeleteSegmentRequest.Builder> deleteSegmentRequest) Deletes a segment from an application.default DeleteSegmentResponsedeleteSegment(DeleteSegmentRequest deleteSegmentRequest) Deletes a segment from an application.default DeleteSmsChannelResponsedeleteSmsChannel(Consumer<DeleteSmsChannelRequest.Builder> deleteSmsChannelRequest) Disables the SMS channel for an application and deletes any existing settings for the channel.default DeleteSmsChannelResponsedeleteSmsChannel(DeleteSmsChannelRequest deleteSmsChannelRequest) Disables the SMS channel for an application and deletes any existing settings for the channel.default DeleteSmsTemplateResponsedeleteSmsTemplate(Consumer<DeleteSmsTemplateRequest.Builder> deleteSmsTemplateRequest) Deletes a message template for messages that were sent through the SMS channel.default DeleteSmsTemplateResponsedeleteSmsTemplate(DeleteSmsTemplateRequest deleteSmsTemplateRequest) Deletes a message template for messages that were sent through the SMS channel.default DeleteUserEndpointsResponsedeleteUserEndpoints(Consumer<DeleteUserEndpointsRequest.Builder> deleteUserEndpointsRequest) Deletes all the endpoints that are associated with a specific user ID.default DeleteUserEndpointsResponsedeleteUserEndpoints(DeleteUserEndpointsRequest deleteUserEndpointsRequest) Deletes all the endpoints that are associated with a specific user ID.default DeleteVoiceChannelResponsedeleteVoiceChannel(Consumer<DeleteVoiceChannelRequest.Builder> deleteVoiceChannelRequest) Disables the voice channel for an application and deletes any existing settings for the channel.default DeleteVoiceChannelResponsedeleteVoiceChannel(DeleteVoiceChannelRequest deleteVoiceChannelRequest) Disables the voice channel for an application and deletes any existing settings for the channel.default DeleteVoiceTemplateResponsedeleteVoiceTemplate(Consumer<DeleteVoiceTemplateRequest.Builder> deleteVoiceTemplateRequest) Deletes a message template for messages that were sent through the voice channel.default DeleteVoiceTemplateResponsedeleteVoiceTemplate(DeleteVoiceTemplateRequest deleteVoiceTemplateRequest) Deletes a message template for messages that were sent through the voice channel.default GetAdmChannelResponsegetAdmChannel(Consumer<GetAdmChannelRequest.Builder> getAdmChannelRequest) Retrieves information about the status and settings of the ADM channel for an application.default GetAdmChannelResponsegetAdmChannel(GetAdmChannelRequest getAdmChannelRequest) Retrieves information about the status and settings of the ADM channel for an application.default GetApnsChannelResponsegetApnsChannel(Consumer<GetApnsChannelRequest.Builder> getApnsChannelRequest) Retrieves information about the status and settings of the APNs channel for an application.default GetApnsChannelResponsegetApnsChannel(GetApnsChannelRequest getApnsChannelRequest) Retrieves information about the status and settings of the APNs channel for an application.default GetApnsSandboxChannelResponsegetApnsSandboxChannel(Consumer<GetApnsSandboxChannelRequest.Builder> getApnsSandboxChannelRequest) Retrieves information about the status and settings of the APNs sandbox channel for an application.default GetApnsSandboxChannelResponsegetApnsSandboxChannel(GetApnsSandboxChannelRequest getApnsSandboxChannelRequest) Retrieves information about the status and settings of the APNs sandbox channel for an application.default GetApnsVoipChannelResponsegetApnsVoipChannel(Consumer<GetApnsVoipChannelRequest.Builder> getApnsVoipChannelRequest) Retrieves information about the status and settings of the APNs VoIP channel for an application.default GetApnsVoipChannelResponsegetApnsVoipChannel(GetApnsVoipChannelRequest getApnsVoipChannelRequest) Retrieves information about the status and settings of the APNs VoIP channel for an application.getApnsVoipSandboxChannel(Consumer<GetApnsVoipSandboxChannelRequest.Builder> getApnsVoipSandboxChannelRequest) Retrieves information about the status and settings of the APNs VoIP sandbox channel for an application.getApnsVoipSandboxChannel(GetApnsVoipSandboxChannelRequest getApnsVoipSandboxChannelRequest) Retrieves information about the status and settings of the APNs VoIP sandbox channel for an application.default GetAppResponsegetApp(Consumer<GetAppRequest.Builder> getAppRequest) Retrieves information about an application.default GetAppResponsegetApp(GetAppRequest getAppRequest) Retrieves information about an application.getApplicationDateRangeKpi(Consumer<GetApplicationDateRangeKpiRequest.Builder> getApplicationDateRangeKpiRequest) Retrieves (queries) pre-aggregated data for a standard metric that applies to an application.getApplicationDateRangeKpi(GetApplicationDateRangeKpiRequest getApplicationDateRangeKpiRequest) Retrieves (queries) pre-aggregated data for a standard metric that applies to an application.default GetApplicationSettingsResponsegetApplicationSettings(Consumer<GetApplicationSettingsRequest.Builder> getApplicationSettingsRequest) Retrieves information about the settings for an application.default GetApplicationSettingsResponsegetApplicationSettings(GetApplicationSettingsRequest getApplicationSettingsRequest) Retrieves information about the settings for an application.default GetAppsResponsegetApps(Consumer<GetAppsRequest.Builder> getAppsRequest) Retrieves information about all the applications that are associated with your Amazon Pinpoint account.default GetAppsResponsegetApps(GetAppsRequest getAppsRequest) Retrieves information about all the applications that are associated with your Amazon Pinpoint account.default GetBaiduChannelResponsegetBaiduChannel(Consumer<GetBaiduChannelRequest.Builder> getBaiduChannelRequest) Retrieves information about the status and settings of the Baidu channel for an application.default GetBaiduChannelResponsegetBaiduChannel(GetBaiduChannelRequest getBaiduChannelRequest) Retrieves information about the status and settings of the Baidu channel for an application.default GetCampaignResponsegetCampaign(Consumer<GetCampaignRequest.Builder> getCampaignRequest) Retrieves information about the status, configuration, and other settings for a campaign.default GetCampaignResponsegetCampaign(GetCampaignRequest getCampaignRequest) Retrieves information about the status, configuration, and other settings for a campaign.default GetCampaignActivitiesResponsegetCampaignActivities(Consumer<GetCampaignActivitiesRequest.Builder> getCampaignActivitiesRequest) Retrieves information about all the activities for a campaign.default GetCampaignActivitiesResponsegetCampaignActivities(GetCampaignActivitiesRequest getCampaignActivitiesRequest) Retrieves information about all the activities for a campaign.default GetCampaignDateRangeKpiResponsegetCampaignDateRangeKpi(Consumer<GetCampaignDateRangeKpiRequest.Builder> getCampaignDateRangeKpiRequest) Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign.default GetCampaignDateRangeKpiResponsegetCampaignDateRangeKpi(GetCampaignDateRangeKpiRequest getCampaignDateRangeKpiRequest) Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign.default GetCampaignsResponsegetCampaigns(Consumer<GetCampaignsRequest.Builder> getCampaignsRequest) Retrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application.default GetCampaignsResponsegetCampaigns(GetCampaignsRequest getCampaignsRequest) Retrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application.default GetCampaignVersionResponsegetCampaignVersion(Consumer<GetCampaignVersionRequest.Builder> getCampaignVersionRequest) Retrieves information about the status, configuration, and other settings for a specific version of a campaign.default GetCampaignVersionResponsegetCampaignVersion(GetCampaignVersionRequest getCampaignVersionRequest) Retrieves information about the status, configuration, and other settings for a specific version of a campaign.default GetCampaignVersionsResponsegetCampaignVersions(Consumer<GetCampaignVersionsRequest.Builder> getCampaignVersionsRequest) Retrieves information about the status, configuration, and other settings for all versions of a campaign.default GetCampaignVersionsResponsegetCampaignVersions(GetCampaignVersionsRequest getCampaignVersionsRequest) Retrieves information about the status, configuration, and other settings for all versions of a campaign.default GetChannelsResponsegetChannels(Consumer<GetChannelsRequest.Builder> getChannelsRequest) Retrieves information about the history and status of each channel for an application.default GetChannelsResponsegetChannels(GetChannelsRequest getChannelsRequest) Retrieves information about the history and status of each channel for an application.default GetEmailChannelResponsegetEmailChannel(Consumer<GetEmailChannelRequest.Builder> getEmailChannelRequest) Retrieves information about the status and settings of the email channel for an application.default GetEmailChannelResponsegetEmailChannel(GetEmailChannelRequest getEmailChannelRequest) Retrieves information about the status and settings of the email channel for an application.default GetEmailTemplateResponsegetEmailTemplate(Consumer<GetEmailTemplateRequest.Builder> getEmailTemplateRequest) Retrieves the content and settings of a message template for messages that are sent through the email channel.default GetEmailTemplateResponsegetEmailTemplate(GetEmailTemplateRequest getEmailTemplateRequest) Retrieves the content and settings of a message template for messages that are sent through the email channel.default GetEndpointResponsegetEndpoint(Consumer<GetEndpointRequest.Builder> getEndpointRequest) Retrieves information about the settings and attributes of a specific endpoint for an application.default GetEndpointResponsegetEndpoint(GetEndpointRequest getEndpointRequest) Retrieves information about the settings and attributes of a specific endpoint for an application.default GetEventStreamResponsegetEventStream(Consumer<GetEventStreamRequest.Builder> getEventStreamRequest) Retrieves information about the event stream settings for an application.default GetEventStreamResponsegetEventStream(GetEventStreamRequest getEventStreamRequest) Retrieves information about the event stream settings for an application.default GetExportJobResponsegetExportJob(Consumer<GetExportJobRequest.Builder> getExportJobRequest) Retrieves information about the status and settings of a specific export job for an application.default GetExportJobResponsegetExportJob(GetExportJobRequest getExportJobRequest) Retrieves information about the status and settings of a specific export job for an application.default GetExportJobsResponsegetExportJobs(Consumer<GetExportJobsRequest.Builder> getExportJobsRequest) Retrieves information about the status and settings of all the export jobs for an application.default GetExportJobsResponsegetExportJobs(GetExportJobsRequest getExportJobsRequest) Retrieves information about the status and settings of all the export jobs for an application.default GetGcmChannelResponsegetGcmChannel(Consumer<GetGcmChannelRequest.Builder> getGcmChannelRequest) Retrieves information about the status and settings of the GCM channel for an application.default GetGcmChannelResponsegetGcmChannel(GetGcmChannelRequest getGcmChannelRequest) Retrieves information about the status and settings of the GCM channel for an application.default GetImportJobResponsegetImportJob(Consumer<GetImportJobRequest.Builder> getImportJobRequest) Retrieves information about the status and settings of a specific import job for an application.default GetImportJobResponsegetImportJob(GetImportJobRequest getImportJobRequest) Retrieves information about the status and settings of a specific import job for an application.default GetImportJobsResponsegetImportJobs(Consumer<GetImportJobsRequest.Builder> getImportJobsRequest) Retrieves information about the status and settings of all the import jobs for an application.default GetImportJobsResponsegetImportJobs(GetImportJobsRequest getImportJobsRequest) Retrieves information about the status and settings of all the import jobs for an application.default GetInAppMessagesResponsegetInAppMessages(Consumer<GetInAppMessagesRequest.Builder> getInAppMessagesRequest) Retrieves the in-app messages targeted for the provided endpoint ID.default GetInAppMessagesResponsegetInAppMessages(GetInAppMessagesRequest getInAppMessagesRequest) Retrieves the in-app messages targeted for the provided endpoint ID.default GetInAppTemplateResponsegetInAppTemplate(Consumer<GetInAppTemplateRequest.Builder> getInAppTemplateRequest) Retrieves the content and settings of a message template for messages sent through the in-app channel.default GetInAppTemplateResponsegetInAppTemplate(GetInAppTemplateRequest getInAppTemplateRequest) Retrieves the content and settings of a message template for messages sent through the in-app channel.default GetJourneyResponsegetJourney(Consumer<GetJourneyRequest.Builder> getJourneyRequest) Retrieves information about the status, configuration, and other settings for a journey.default GetJourneyResponsegetJourney(GetJourneyRequest getJourneyRequest) Retrieves information about the status, configuration, and other settings for a journey.default GetJourneyDateRangeKpiResponsegetJourneyDateRangeKpi(Consumer<GetJourneyDateRangeKpiRequest.Builder> getJourneyDateRangeKpiRequest) Retrieves (queries) pre-aggregated data for a standard engagement metric that applies to a journey.default GetJourneyDateRangeKpiResponsegetJourneyDateRangeKpi(GetJourneyDateRangeKpiRequest getJourneyDateRangeKpiRequest) Retrieves (queries) pre-aggregated data for a standard engagement metric that applies to a journey.getJourneyExecutionActivityMetrics(Consumer<GetJourneyExecutionActivityMetricsRequest.Builder> getJourneyExecutionActivityMetricsRequest) Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey activity.getJourneyExecutionActivityMetrics(GetJourneyExecutionActivityMetricsRequest getJourneyExecutionActivityMetricsRequest) Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey activity.getJourneyExecutionMetrics(Consumer<GetJourneyExecutionMetricsRequest.Builder> getJourneyExecutionMetricsRequest) Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey.getJourneyExecutionMetrics(GetJourneyExecutionMetricsRequest getJourneyExecutionMetricsRequest) Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey.getJourneyRunExecutionActivityMetrics(Consumer<GetJourneyRunExecutionActivityMetricsRequest.Builder> getJourneyRunExecutionActivityMetricsRequest) Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey activity.getJourneyRunExecutionActivityMetrics(GetJourneyRunExecutionActivityMetricsRequest getJourneyRunExecutionActivityMetricsRequest) Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey activity.getJourneyRunExecutionMetrics(Consumer<GetJourneyRunExecutionMetricsRequest.Builder> getJourneyRunExecutionMetricsRequest) Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey.getJourneyRunExecutionMetrics(GetJourneyRunExecutionMetricsRequest getJourneyRunExecutionMetricsRequest) Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey.default GetJourneyRunsResponsegetJourneyRuns(Consumer<GetJourneyRunsRequest.Builder> getJourneyRunsRequest) Provides information about the runs of a journey.default GetJourneyRunsResponsegetJourneyRuns(GetJourneyRunsRequest getJourneyRunsRequest) Provides information about the runs of a journey.default GetPushTemplateResponsegetPushTemplate(Consumer<GetPushTemplateRequest.Builder> getPushTemplateRequest) Retrieves the content and settings of a message template for messages that are sent through a push notification channel.default GetPushTemplateResponsegetPushTemplate(GetPushTemplateRequest getPushTemplateRequest) Retrieves the content and settings of a message template for messages that are sent through a push notification channel.getRecommenderConfiguration(Consumer<GetRecommenderConfigurationRequest.Builder> getRecommenderConfigurationRequest) Retrieves information about an Amazon Pinpoint configuration for a recommender model.getRecommenderConfiguration(GetRecommenderConfigurationRequest getRecommenderConfigurationRequest) Retrieves information about an Amazon Pinpoint configuration for a recommender model.getRecommenderConfigurations(Consumer<GetRecommenderConfigurationsRequest.Builder> getRecommenderConfigurationsRequest) Retrieves information about all the recommender model configurations that are associated with your Amazon Pinpoint account.getRecommenderConfigurations(GetRecommenderConfigurationsRequest getRecommenderConfigurationsRequest) Retrieves information about all the recommender model configurations that are associated with your Amazon Pinpoint account.default GetSegmentResponsegetSegment(Consumer<GetSegmentRequest.Builder> getSegmentRequest) Retrieves information about the configuration, dimension, and other settings for a specific segment that's associated with an application.default GetSegmentResponsegetSegment(GetSegmentRequest getSegmentRequest) Retrieves information about the configuration, dimension, and other settings for a specific segment that's associated with an application.default GetSegmentExportJobsResponsegetSegmentExportJobs(Consumer<GetSegmentExportJobsRequest.Builder> getSegmentExportJobsRequest) Retrieves information about the status and settings of the export jobs for a segment.default GetSegmentExportJobsResponsegetSegmentExportJobs(GetSegmentExportJobsRequest getSegmentExportJobsRequest) Retrieves information about the status and settings of the export jobs for a segment.default GetSegmentImportJobsResponsegetSegmentImportJobs(Consumer<GetSegmentImportJobsRequest.Builder> getSegmentImportJobsRequest) Retrieves information about the status and settings of the import jobs for a segment.default GetSegmentImportJobsResponsegetSegmentImportJobs(GetSegmentImportJobsRequest getSegmentImportJobsRequest) Retrieves information about the status and settings of the import jobs for a segment.default GetSegmentsResponsegetSegments(Consumer<GetSegmentsRequest.Builder> getSegmentsRequest) Retrieves information about the configuration, dimension, and other settings for all the segments that are associated with an application.default GetSegmentsResponsegetSegments(GetSegmentsRequest getSegmentsRequest) Retrieves information about the configuration, dimension, and other settings for all the segments that are associated with an application.default GetSegmentVersionResponsegetSegmentVersion(Consumer<GetSegmentVersionRequest.Builder> getSegmentVersionRequest) Retrieves information about the configuration, dimension, and other settings for a specific version of a segment that's associated with an application.default GetSegmentVersionResponsegetSegmentVersion(GetSegmentVersionRequest getSegmentVersionRequest) Retrieves information about the configuration, dimension, and other settings for a specific version of a segment that's associated with an application.default GetSegmentVersionsResponsegetSegmentVersions(Consumer<GetSegmentVersionsRequest.Builder> getSegmentVersionsRequest) Retrieves information about the configuration, dimension, and other settings for all the versions of a specific segment that's associated with an application.default GetSegmentVersionsResponsegetSegmentVersions(GetSegmentVersionsRequest getSegmentVersionsRequest) Retrieves information about the configuration, dimension, and other settings for all the versions of a specific segment that's associated with an application.default GetSmsChannelResponsegetSmsChannel(Consumer<GetSmsChannelRequest.Builder> getSmsChannelRequest) Retrieves information about the status and settings of the SMS channel for an application.default GetSmsChannelResponsegetSmsChannel(GetSmsChannelRequest getSmsChannelRequest) Retrieves information about the status and settings of the SMS channel for an application.default GetSmsTemplateResponsegetSmsTemplate(Consumer<GetSmsTemplateRequest.Builder> getSmsTemplateRequest) Retrieves the content and settings of a message template for messages that are sent through the SMS channel.default GetSmsTemplateResponsegetSmsTemplate(GetSmsTemplateRequest getSmsTemplateRequest) Retrieves the content and settings of a message template for messages that are sent through the SMS channel.default GetUserEndpointsResponsegetUserEndpoints(Consumer<GetUserEndpointsRequest.Builder> getUserEndpointsRequest) Retrieves information about all the endpoints that are associated with a specific user ID.default GetUserEndpointsResponsegetUserEndpoints(GetUserEndpointsRequest getUserEndpointsRequest) Retrieves information about all the endpoints that are associated with a specific user ID.default GetVoiceChannelResponsegetVoiceChannel(Consumer<GetVoiceChannelRequest.Builder> getVoiceChannelRequest) Retrieves information about the status and settings of the voice channel for an application.default GetVoiceChannelResponsegetVoiceChannel(GetVoiceChannelRequest getVoiceChannelRequest) Retrieves information about the status and settings of the voice channel for an application.default GetVoiceTemplateResponsegetVoiceTemplate(Consumer<GetVoiceTemplateRequest.Builder> getVoiceTemplateRequest) Retrieves the content and settings of a message template for messages that are sent through the voice channel.default GetVoiceTemplateResponsegetVoiceTemplate(GetVoiceTemplateRequest getVoiceTemplateRequest) Retrieves the content and settings of a message template for messages that are sent through the voice channel.default ListJourneysResponselistJourneys(Consumer<ListJourneysRequest.Builder> listJourneysRequest) Retrieves information about the status, configuration, and other settings for all the journeys that are associated with an application.default ListJourneysResponselistJourneys(ListJourneysRequest listJourneysRequest) Retrieves information about the status, configuration, and other settings for all the journeys that are associated with an application.default ListTagsForResourceResponselistTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Retrieves all the tags (keys and values) that are associated with an application, campaign, message template, or segment.default ListTagsForResourceResponselistTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Retrieves all the tags (keys and values) that are associated with an application, campaign, message template, or segment.default ListTemplatesResponselistTemplates(Consumer<ListTemplatesRequest.Builder> listTemplatesRequest) Retrieves information about all the message templates that are associated with your Amazon Pinpoint account.default ListTemplatesResponselistTemplates(ListTemplatesRequest listTemplatesRequest) Retrieves information about all the message templates that are associated with your Amazon Pinpoint account.default ListTemplateVersionsResponselistTemplateVersions(Consumer<ListTemplateVersionsRequest.Builder> listTemplateVersionsRequest) Retrieves information about all the versions of a specific message template.default ListTemplateVersionsResponselistTemplateVersions(ListTemplateVersionsRequest listTemplateVersionsRequest) Retrieves information about all the versions of a specific message template.default PhoneNumberValidateResponsephoneNumberValidate(Consumer<PhoneNumberValidateRequest.Builder> phoneNumberValidateRequest) Retrieves information about a phone number.default PhoneNumberValidateResponsephoneNumberValidate(PhoneNumberValidateRequest phoneNumberValidateRequest) Retrieves information about a phone number.default PutEventsResponseputEvents(Consumer<PutEventsRequest.Builder> putEventsRequest) Creates a new event to record for endpoints, or creates or updates endpoint data that existing events are associated with.default PutEventsResponseputEvents(PutEventsRequest putEventsRequest) Creates a new event to record for endpoints, or creates or updates endpoint data that existing events are associated with.default PutEventStreamResponseputEventStream(Consumer<PutEventStreamRequest.Builder> putEventStreamRequest) Creates a new event stream for an application or updates the settings of an existing event stream for an application.default PutEventStreamResponseputEventStream(PutEventStreamRequest putEventStreamRequest) Creates a new event stream for an application or updates the settings of an existing event stream for an application.default RemoveAttributesResponseremoveAttributes(Consumer<RemoveAttributesRequest.Builder> removeAttributesRequest) Removes one or more custom attributes, of the same attribute type, from the application.default RemoveAttributesResponseremoveAttributes(RemoveAttributesRequest removeAttributesRequest) Removes one or more custom attributes, of the same attribute type, from the application.default SendMessagesResponsesendMessages(Consumer<SendMessagesRequest.Builder> sendMessagesRequest) Creates and sends a direct message.default SendMessagesResponsesendMessages(SendMessagesRequest sendMessagesRequest) Creates and sends a direct message.default SendOtpMessageResponsesendOTPMessage(Consumer<SendOtpMessageRequest.Builder> sendOtpMessageRequest) Send an OTP messagedefault SendOtpMessageResponsesendOTPMessage(SendOtpMessageRequest sendOtpMessageRequest) Send an OTP messagedefault SendUsersMessagesResponsesendUsersMessages(Consumer<SendUsersMessagesRequest.Builder> sendUsersMessagesRequest) Creates and sends a message to a list of users.default SendUsersMessagesResponsesendUsersMessages(SendUsersMessagesRequest sendUsersMessagesRequest) Creates and sends a message to a list of users.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadatadefault TagResourceResponsetagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds one or more tags (keys and values) to an application, campaign, message template, or segment.default TagResourceResponsetagResource(TagResourceRequest tagResourceRequest) Adds one or more tags (keys and values) to an application, campaign, message template, or segment.default UntagResourceResponseuntagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes one or more tags (keys and values) from an application, campaign, message template, or segment.default UntagResourceResponseuntagResource(UntagResourceRequest untagResourceRequest) Removes one or more tags (keys and values) from an application, campaign, message template, or segment.default UpdateAdmChannelResponseupdateAdmChannel(Consumer<UpdateAdmChannelRequest.Builder> updateAdmChannelRequest) Enables the ADM channel for an application or updates the status and settings of the ADM channel for an application.default UpdateAdmChannelResponseupdateAdmChannel(UpdateAdmChannelRequest updateAdmChannelRequest) Enables the ADM channel for an application or updates the status and settings of the ADM channel for an application.default UpdateApnsChannelResponseupdateApnsChannel(Consumer<UpdateApnsChannelRequest.Builder> updateApnsChannelRequest) Enables the APNs channel for an application or updates the status and settings of the APNs channel for an application.default UpdateApnsChannelResponseupdateApnsChannel(UpdateApnsChannelRequest updateApnsChannelRequest) Enables the APNs channel for an application or updates the status and settings of the APNs channel for an application.default UpdateApnsSandboxChannelResponseupdateApnsSandboxChannel(Consumer<UpdateApnsSandboxChannelRequest.Builder> updateApnsSandboxChannelRequest) Enables the APNs sandbox channel for an application or updates the status and settings of the APNs sandbox channel for an application.default UpdateApnsSandboxChannelResponseupdateApnsSandboxChannel(UpdateApnsSandboxChannelRequest updateApnsSandboxChannelRequest) Enables the APNs sandbox channel for an application or updates the status and settings of the APNs sandbox channel for an application.default UpdateApnsVoipChannelResponseupdateApnsVoipChannel(Consumer<UpdateApnsVoipChannelRequest.Builder> updateApnsVoipChannelRequest) Enables the APNs VoIP channel for an application or updates the status and settings of the APNs VoIP channel for an application.default UpdateApnsVoipChannelResponseupdateApnsVoipChannel(UpdateApnsVoipChannelRequest updateApnsVoipChannelRequest) Enables the APNs VoIP channel for an application or updates the status and settings of the APNs VoIP channel for an application.updateApnsVoipSandboxChannel(Consumer<UpdateApnsVoipSandboxChannelRequest.Builder> updateApnsVoipSandboxChannelRequest) Enables the APNs VoIP sandbox channel for an application or updates the status and settings of the APNs VoIP sandbox channel for an application.updateApnsVoipSandboxChannel(UpdateApnsVoipSandboxChannelRequest updateApnsVoipSandboxChannelRequest) Enables the APNs VoIP sandbox channel for an application or updates the status and settings of the APNs VoIP sandbox channel for an application.updateApplicationSettings(Consumer<UpdateApplicationSettingsRequest.Builder> updateApplicationSettingsRequest) Updates the settings for an application.updateApplicationSettings(UpdateApplicationSettingsRequest updateApplicationSettingsRequest) Updates the settings for an application.default UpdateBaiduChannelResponseupdateBaiduChannel(Consumer<UpdateBaiduChannelRequest.Builder> updateBaiduChannelRequest) Enables the Baidu channel for an application or updates the status and settings of the Baidu channel for an application.default UpdateBaiduChannelResponseupdateBaiduChannel(UpdateBaiduChannelRequest updateBaiduChannelRequest) Enables the Baidu channel for an application or updates the status and settings of the Baidu channel for an application.default UpdateCampaignResponseupdateCampaign(Consumer<UpdateCampaignRequest.Builder> updateCampaignRequest) Updates the configuration and other settings for a campaign.default UpdateCampaignResponseupdateCampaign(UpdateCampaignRequest updateCampaignRequest) Updates the configuration and other settings for a campaign.default UpdateEmailChannelResponseupdateEmailChannel(Consumer<UpdateEmailChannelRequest.Builder> updateEmailChannelRequest) Enables the email channel for an application or updates the status and settings of the email channel for an application.default UpdateEmailChannelResponseupdateEmailChannel(UpdateEmailChannelRequest updateEmailChannelRequest) Enables the email channel for an application or updates the status and settings of the email channel for an application.default UpdateEmailTemplateResponseupdateEmailTemplate(Consumer<UpdateEmailTemplateRequest.Builder> updateEmailTemplateRequest) Updates an existing message template for messages that are sent through the email channel.default UpdateEmailTemplateResponseupdateEmailTemplate(UpdateEmailTemplateRequest updateEmailTemplateRequest) Updates an existing message template for messages that are sent through the email channel.default UpdateEndpointResponseupdateEndpoint(Consumer<UpdateEndpointRequest.Builder> updateEndpointRequest) Creates a new endpoint for an application or updates the settings and attributes of an existing endpoint for an application.default UpdateEndpointResponseupdateEndpoint(UpdateEndpointRequest updateEndpointRequest) Creates a new endpoint for an application or updates the settings and attributes of an existing endpoint for an application.default UpdateEndpointsBatchResponseupdateEndpointsBatch(Consumer<UpdateEndpointsBatchRequest.Builder> 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.default UpdateEndpointsBatchResponseupdateEndpointsBatch(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.default UpdateGcmChannelResponseupdateGcmChannel(Consumer<UpdateGcmChannelRequest.Builder> updateGcmChannelRequest) Enables the GCM channel for an application or updates the status and settings of the GCM channel for an application.default UpdateGcmChannelResponseupdateGcmChannel(UpdateGcmChannelRequest updateGcmChannelRequest) Enables the GCM channel for an application or updates the status and settings of the GCM channel for an application.default UpdateInAppTemplateResponseupdateInAppTemplate(Consumer<UpdateInAppTemplateRequest.Builder> updateInAppTemplateRequest) Updates an existing message template for messages sent through the in-app message channel.default UpdateInAppTemplateResponseupdateInAppTemplate(UpdateInAppTemplateRequest updateInAppTemplateRequest) Updates an existing message template for messages sent through the in-app message channel.default UpdateJourneyResponseupdateJourney(Consumer<UpdateJourneyRequest.Builder> updateJourneyRequest) Updates the configuration and other settings for a journey.default UpdateJourneyResponseupdateJourney(UpdateJourneyRequest updateJourneyRequest) Updates the configuration and other settings for a journey.default UpdateJourneyStateResponseupdateJourneyState(Consumer<UpdateJourneyStateRequest.Builder> updateJourneyStateRequest) Cancels (stops) an active journey.default UpdateJourneyStateResponseupdateJourneyState(UpdateJourneyStateRequest updateJourneyStateRequest) Cancels (stops) an active journey.default UpdatePushTemplateResponseupdatePushTemplate(Consumer<UpdatePushTemplateRequest.Builder> updatePushTemplateRequest) Updates an existing message template for messages that are sent through a push notification channel.default UpdatePushTemplateResponseupdatePushTemplate(UpdatePushTemplateRequest updatePushTemplateRequest) Updates an existing message template for messages that are sent through a push notification channel.updateRecommenderConfiguration(Consumer<UpdateRecommenderConfigurationRequest.Builder> updateRecommenderConfigurationRequest) Updates an Amazon Pinpoint configuration for a recommender model.updateRecommenderConfiguration(UpdateRecommenderConfigurationRequest updateRecommenderConfigurationRequest) Updates an Amazon Pinpoint configuration for a recommender model.default UpdateSegmentResponseupdateSegment(Consumer<UpdateSegmentRequest.Builder> 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.default UpdateSegmentResponseupdateSegment(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.default UpdateSmsChannelResponseupdateSmsChannel(Consumer<UpdateSmsChannelRequest.Builder> updateSmsChannelRequest) Enables the SMS channel for an application or updates the status and settings of the SMS channel for an application.default UpdateSmsChannelResponseupdateSmsChannel(UpdateSmsChannelRequest updateSmsChannelRequest) Enables the SMS channel for an application or updates the status and settings of the SMS channel for an application.default UpdateSmsTemplateResponseupdateSmsTemplate(Consumer<UpdateSmsTemplateRequest.Builder> updateSmsTemplateRequest) Updates an existing message template for messages that are sent through the SMS channel.default UpdateSmsTemplateResponseupdateSmsTemplate(UpdateSmsTemplateRequest updateSmsTemplateRequest) Updates an existing message template for messages that are sent through the SMS channel.updateTemplateActiveVersion(Consumer<UpdateTemplateActiveVersionRequest.Builder> updateTemplateActiveVersionRequest) Changes the status of a specific version of a message template to active.updateTemplateActiveVersion(UpdateTemplateActiveVersionRequest updateTemplateActiveVersionRequest) Changes the status of a specific version of a message template to active.default UpdateVoiceChannelResponseupdateVoiceChannel(Consumer<UpdateVoiceChannelRequest.Builder> updateVoiceChannelRequest) Enables the voice channel for an application or updates the status and settings of the voice channel for an application.default UpdateVoiceChannelResponseupdateVoiceChannel(UpdateVoiceChannelRequest updateVoiceChannelRequest) Enables the voice channel for an application or updates the status and settings of the voice channel for an application.default UpdateVoiceTemplateResponseupdateVoiceTemplate(Consumer<UpdateVoiceTemplateRequest.Builder> updateVoiceTemplateRequest) Updates an existing message template for messages that are sent through the voice channel.default UpdateVoiceTemplateResponseupdateVoiceTemplate(UpdateVoiceTemplateRequest updateVoiceTemplateRequest) Updates an existing message template for messages that are sent through the voice channel.default VerifyOtpMessageResponseverifyOTPMessage(Consumer<VerifyOtpMessageRequest.Builder> verifyOtpMessageRequest) Verify an OTPdefault VerifyOtpMessageResponseverifyOTPMessage(VerifyOtpMessageRequest verifyOtpMessageRequest) Verify an OTPMethods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
-
-
Method Details
-
createApp
default CreateAppResponse createApp(CreateAppRequest createAppRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Creates an application.
- Parameters:
createAppRequest-- Returns:
- Result of the CreateApp operation returned by the service.
- See Also:
-
createApp
default CreateAppResponse createApp(Consumer<CreateAppRequest.Builder> createAppRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Creates an application.
This is a convenience which creates an instance of the
CreateAppRequest.Builderavoiding the need to create one manually viaCreateAppRequest.builder()- Parameters:
createAppRequest- AConsumerthat will call methods onCreateAppRequest.Builderto create a request.- Returns:
- Result of the CreateApp operation returned by the service.
- See Also:
-
createCampaign
default CreateCampaignResponse createCampaign(CreateCampaignRequest createCampaignRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException 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.
- See Also:
-
createCampaign
default CreateCampaignResponse createCampaign(Consumer<CreateCampaignRequest.Builder> createCampaignRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Creates a new campaign for an application or updates the settings of an existing campaign for an application.
This is a convenience which creates an instance of the
CreateCampaignRequest.Builderavoiding the need to create one manually viaCreateCampaignRequest.builder()- Parameters:
createCampaignRequest- AConsumerthat will call methods onCreateCampaignRequest.Builderto create a request.- Returns:
- Result of the CreateCampaign operation returned by the service.
- See Also:
-
createEmailTemplate
default CreateEmailTemplateResponse createEmailTemplate(CreateEmailTemplateRequest createEmailTemplateRequest) throws MethodNotAllowedException, TooManyRequestsException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, PinpointException Creates a message template for messages that are sent through the email channel.
- Parameters:
createEmailTemplateRequest-- Returns:
- Result of the CreateEmailTemplate operation returned by the service.
- See Also:
-
createEmailTemplate
default CreateEmailTemplateResponse createEmailTemplate(Consumer<CreateEmailTemplateRequest.Builder> createEmailTemplateRequest) throws MethodNotAllowedException, TooManyRequestsException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, PinpointException Creates a message template for messages that are sent through the email channel.
This is a convenience which creates an instance of the
CreateEmailTemplateRequest.Builderavoiding the need to create one manually viaCreateEmailTemplateRequest.builder()- Parameters:
createEmailTemplateRequest- AConsumerthat will call methods onCreateEmailTemplateRequest.Builderto create a request.- Returns:
- Result of the CreateEmailTemplate operation returned by the service.
- See Also:
-
createExportJob
default CreateExportJobResponse createExportJob(CreateExportJobRequest createExportJobRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Creates an export job for an application.
- Parameters:
createExportJobRequest-- Returns:
- Result of the CreateExportJob operation returned by the service.
- See Also:
-
createExportJob
default CreateExportJobResponse createExportJob(Consumer<CreateExportJobRequest.Builder> createExportJobRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Creates an export job for an application.
This is a convenience which creates an instance of the
CreateExportJobRequest.Builderavoiding the need to create one manually viaCreateExportJobRequest.builder()- Parameters:
createExportJobRequest- AConsumerthat will call methods onCreateExportJobRequest.Builderto create a request.- Returns:
- Result of the CreateExportJob operation returned by the service.
- See Also:
-
createImportJob
default CreateImportJobResponse createImportJob(CreateImportJobRequest createImportJobRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Creates an import job for an application.
- Parameters:
createImportJobRequest-- Returns:
- Result of the CreateImportJob operation returned by the service.
- See Also:
-
createImportJob
default CreateImportJobResponse createImportJob(Consumer<CreateImportJobRequest.Builder> createImportJobRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Creates an import job for an application.
This is a convenience which creates an instance of the
CreateImportJobRequest.Builderavoiding the need to create one manually viaCreateImportJobRequest.builder()- Parameters:
createImportJobRequest- AConsumerthat will call methods onCreateImportJobRequest.Builderto create a request.- Returns:
- Result of the CreateImportJob operation returned by the service.
- See Also:
-
createInAppTemplate
default CreateInAppTemplateResponse createInAppTemplate(CreateInAppTemplateRequest createInAppTemplateRequest) throws MethodNotAllowedException, TooManyRequestsException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, PinpointException Creates a new message template for messages using the in-app message channel.
- Parameters:
createInAppTemplateRequest-- Returns:
- Result of the CreateInAppTemplate operation returned by the service.
- See Also:
-
createInAppTemplate
default CreateInAppTemplateResponse createInAppTemplate(Consumer<CreateInAppTemplateRequest.Builder> createInAppTemplateRequest) throws MethodNotAllowedException, TooManyRequestsException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, PinpointException Creates a new message template for messages using the in-app message channel.
This is a convenience which creates an instance of the
CreateInAppTemplateRequest.Builderavoiding the need to create one manually viaCreateInAppTemplateRequest.builder()- Parameters:
createInAppTemplateRequest- AConsumerthat will call methods onCreateInAppTemplateRequest.Builderto create a request.- Returns:
- Result of the CreateInAppTemplate operation returned by the service.
- See Also:
-
createJourney
default CreateJourneyResponse createJourney(CreateJourneyRequest createJourneyRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Creates a journey for an application.
- Parameters:
createJourneyRequest-- Returns:
- Result of the CreateJourney operation returned by the service.
- See Also:
-
createJourney
default CreateJourneyResponse createJourney(Consumer<CreateJourneyRequest.Builder> createJourneyRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Creates a journey for an application.
This is a convenience which creates an instance of the
CreateJourneyRequest.Builderavoiding the need to create one manually viaCreateJourneyRequest.builder()- Parameters:
createJourneyRequest- AConsumerthat will call methods onCreateJourneyRequest.Builderto create a request.- Returns:
- Result of the CreateJourney operation returned by the service.
- See Also:
-
createPushTemplate
default CreatePushTemplateResponse createPushTemplate(CreatePushTemplateRequest createPushTemplateRequest) throws MethodNotAllowedException, TooManyRequestsException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, PinpointException Creates a message template for messages that are sent through a push notification channel.
- Parameters:
createPushTemplateRequest-- Returns:
- Result of the CreatePushTemplate operation returned by the service.
- See Also:
-
createPushTemplate
default CreatePushTemplateResponse createPushTemplate(Consumer<CreatePushTemplateRequest.Builder> createPushTemplateRequest) throws MethodNotAllowedException, TooManyRequestsException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, PinpointException Creates a message template for messages that are sent through a push notification channel.
This is a convenience which creates an instance of the
CreatePushTemplateRequest.Builderavoiding the need to create one manually viaCreatePushTemplateRequest.builder()- Parameters:
createPushTemplateRequest- AConsumerthat will call methods onCreatePushTemplateRequest.Builderto create a request.- Returns:
- Result of the CreatePushTemplate operation returned by the service.
- See Also:
-
createRecommenderConfiguration
default CreateRecommenderConfigurationResponse createRecommenderConfiguration(CreateRecommenderConfigurationRequest createRecommenderConfigurationRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Creates an Amazon Pinpoint configuration for a recommender model.
- Parameters:
createRecommenderConfigurationRequest-- Returns:
- Result of the CreateRecommenderConfiguration operation returned by the service.
- See Also:
-
createRecommenderConfiguration
default CreateRecommenderConfigurationResponse createRecommenderConfiguration(Consumer<CreateRecommenderConfigurationRequest.Builder> createRecommenderConfigurationRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Creates an Amazon Pinpoint configuration for a recommender model.
This is a convenience which creates an instance of the
CreateRecommenderConfigurationRequest.Builderavoiding the need to create one manually viaCreateRecommenderConfigurationRequest.builder()- Parameters:
createRecommenderConfigurationRequest- AConsumerthat will call methods onCreateRecommenderConfigurationRequest.Builderto create a request.- Returns:
- Result of the CreateRecommenderConfiguration operation returned by the service.
- See Also:
-
createSegment
default CreateSegmentResponse createSegment(CreateSegmentRequest createSegmentRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException 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.
- See Also:
-
createSegment
default CreateSegmentResponse createSegment(Consumer<CreateSegmentRequest.Builder> createSegmentRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException 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.
This is a convenience which creates an instance of the
CreateSegmentRequest.Builderavoiding the need to create one manually viaCreateSegmentRequest.builder()- Parameters:
createSegmentRequest- AConsumerthat will call methods onCreateSegmentRequest.Builderto create a request.- Returns:
- Result of the CreateSegment operation returned by the service.
- See Also:
-
createSmsTemplate
default CreateSmsTemplateResponse createSmsTemplate(CreateSmsTemplateRequest createSmsTemplateRequest) throws MethodNotAllowedException, TooManyRequestsException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, PinpointException Creates a message template for messages that are sent through the SMS channel.
- Parameters:
createSmsTemplateRequest-- Returns:
- Result of the CreateSmsTemplate operation returned by the service.
- See Also:
-
createSmsTemplate
default CreateSmsTemplateResponse createSmsTemplate(Consumer<CreateSmsTemplateRequest.Builder> createSmsTemplateRequest) throws MethodNotAllowedException, TooManyRequestsException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, PinpointException Creates a message template for messages that are sent through the SMS channel.
This is a convenience which creates an instance of the
CreateSmsTemplateRequest.Builderavoiding the need to create one manually viaCreateSmsTemplateRequest.builder()- Parameters:
createSmsTemplateRequest- AConsumerthat will call methods onCreateSmsTemplateRequest.Builderto create a request.- Returns:
- Result of the CreateSmsTemplate operation returned by the service.
- See Also:
-
createVoiceTemplate
default CreateVoiceTemplateResponse createVoiceTemplate(CreateVoiceTemplateRequest createVoiceTemplateRequest) throws MethodNotAllowedException, TooManyRequestsException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, PinpointException Creates a message template for messages that are sent through the voice channel.
- Parameters:
createVoiceTemplateRequest-- Returns:
- Result of the CreateVoiceTemplate operation returned by the service.
- See Also:
-
createVoiceTemplate
default CreateVoiceTemplateResponse createVoiceTemplate(Consumer<CreateVoiceTemplateRequest.Builder> createVoiceTemplateRequest) throws MethodNotAllowedException, TooManyRequestsException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, PinpointException Creates a message template for messages that are sent through the voice channel.
This is a convenience which creates an instance of the
CreateVoiceTemplateRequest.Builderavoiding the need to create one manually viaCreateVoiceTemplateRequest.builder()- Parameters:
createVoiceTemplateRequest- AConsumerthat will call methods onCreateVoiceTemplateRequest.Builderto create a request.- Returns:
- Result of the CreateVoiceTemplate operation returned by the service.
- See Also:
-
deleteAdmChannel
default DeleteAdmChannelResponse deleteAdmChannel(DeleteAdmChannelRequest deleteAdmChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException 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.
- See Also:
-
deleteAdmChannel
default DeleteAdmChannelResponse deleteAdmChannel(Consumer<DeleteAdmChannelRequest.Builder> deleteAdmChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Disables the ADM channel for an application and deletes any existing settings for the channel.
This is a convenience which creates an instance of the
DeleteAdmChannelRequest.Builderavoiding the need to create one manually viaDeleteAdmChannelRequest.builder()- Parameters:
deleteAdmChannelRequest- AConsumerthat will call methods onDeleteAdmChannelRequest.Builderto create a request.- Returns:
- Result of the DeleteAdmChannel operation returned by the service.
- See Also:
-
deleteApnsChannel
default DeleteApnsChannelResponse deleteApnsChannel(DeleteApnsChannelRequest deleteApnsChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException 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.
- See Also:
-
deleteApnsChannel
default DeleteApnsChannelResponse deleteApnsChannel(Consumer<DeleteApnsChannelRequest.Builder> deleteApnsChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Disables the APNs channel for an application and deletes any existing settings for the channel.
This is a convenience which creates an instance of the
DeleteApnsChannelRequest.Builderavoiding the need to create one manually viaDeleteApnsChannelRequest.builder()- Parameters:
deleteApnsChannelRequest- AConsumerthat will call methods onDeleteApnsChannelRequest.Builderto create a request.- Returns:
- Result of the DeleteApnsChannel operation returned by the service.
- See Also:
-
deleteApnsSandboxChannel
default DeleteApnsSandboxChannelResponse deleteApnsSandboxChannel(DeleteApnsSandboxChannelRequest deleteApnsSandboxChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException 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.
- See Also:
-
deleteApnsSandboxChannel
default DeleteApnsSandboxChannelResponse deleteApnsSandboxChannel(Consumer<DeleteApnsSandboxChannelRequest.Builder> deleteApnsSandboxChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Disables the APNs sandbox channel for an application and deletes any existing settings for the channel.
This is a convenience which creates an instance of the
DeleteApnsSandboxChannelRequest.Builderavoiding the need to create one manually viaDeleteApnsSandboxChannelRequest.builder()- Parameters:
deleteApnsSandboxChannelRequest- AConsumerthat will call methods onDeleteApnsSandboxChannelRequest.Builderto create a request.- Returns:
- Result of the DeleteApnsSandboxChannel operation returned by the service.
- See Also:
-
deleteApnsVoipChannel
default DeleteApnsVoipChannelResponse deleteApnsVoipChannel(DeleteApnsVoipChannelRequest deleteApnsVoipChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException 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.
- See Also:
-
deleteApnsVoipChannel
default DeleteApnsVoipChannelResponse deleteApnsVoipChannel(Consumer<DeleteApnsVoipChannelRequest.Builder> deleteApnsVoipChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Disables the APNs VoIP channel for an application and deletes any existing settings for the channel.
This is a convenience which creates an instance of the
DeleteApnsVoipChannelRequest.Builderavoiding the need to create one manually viaDeleteApnsVoipChannelRequest.builder()- Parameters:
deleteApnsVoipChannelRequest- AConsumerthat will call methods onDeleteApnsVoipChannelRequest.Builderto create a request.- Returns:
- Result of the DeleteApnsVoipChannel operation returned by the service.
- See Also:
-
deleteApnsVoipSandboxChannel
default DeleteApnsVoipSandboxChannelResponse deleteApnsVoipSandboxChannel(DeleteApnsVoipSandboxChannelRequest deleteApnsVoipSandboxChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException 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.
- See Also:
-
deleteApnsVoipSandboxChannel
default DeleteApnsVoipSandboxChannelResponse deleteApnsVoipSandboxChannel(Consumer<DeleteApnsVoipSandboxChannelRequest.Builder> deleteApnsVoipSandboxChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Disables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel.
This is a convenience which creates an instance of the
DeleteApnsVoipSandboxChannelRequest.Builderavoiding the need to create one manually viaDeleteApnsVoipSandboxChannelRequest.builder()- Parameters:
deleteApnsVoipSandboxChannelRequest- AConsumerthat will call methods onDeleteApnsVoipSandboxChannelRequest.Builderto create a request.- Returns:
- Result of the DeleteApnsVoipSandboxChannel operation returned by the service.
- See Also:
-
deleteApp
default DeleteAppResponse deleteApp(DeleteAppRequest deleteAppRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Deletes an application.
- Parameters:
deleteAppRequest-- Returns:
- Result of the DeleteApp operation returned by the service.
- See Also:
-
deleteApp
default DeleteAppResponse deleteApp(Consumer<DeleteAppRequest.Builder> deleteAppRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Deletes an application.
This is a convenience which creates an instance of the
DeleteAppRequest.Builderavoiding the need to create one manually viaDeleteAppRequest.builder()- Parameters:
deleteAppRequest- AConsumerthat will call methods onDeleteAppRequest.Builderto create a request.- Returns:
- Result of the DeleteApp operation returned by the service.
- See Also:
-
deleteBaiduChannel
default DeleteBaiduChannelResponse deleteBaiduChannel(DeleteBaiduChannelRequest deleteBaiduChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException 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.
- See Also:
-
deleteBaiduChannel
default DeleteBaiduChannelResponse deleteBaiduChannel(Consumer<DeleteBaiduChannelRequest.Builder> deleteBaiduChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Disables the Baidu channel for an application and deletes any existing settings for the channel.
This is a convenience which creates an instance of the
DeleteBaiduChannelRequest.Builderavoiding the need to create one manually viaDeleteBaiduChannelRequest.builder()- Parameters:
deleteBaiduChannelRequest- AConsumerthat will call methods onDeleteBaiduChannelRequest.Builderto create a request.- Returns:
- Result of the DeleteBaiduChannel operation returned by the service.
- See Also:
-
deleteCampaign
default DeleteCampaignResponse deleteCampaign(DeleteCampaignRequest deleteCampaignRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Deletes a campaign from an application.
- Parameters:
deleteCampaignRequest-- Returns:
- Result of the DeleteCampaign operation returned by the service.
- See Also:
-
deleteCampaign
default DeleteCampaignResponse deleteCampaign(Consumer<DeleteCampaignRequest.Builder> deleteCampaignRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Deletes a campaign from an application.
This is a convenience which creates an instance of the
DeleteCampaignRequest.Builderavoiding the need to create one manually viaDeleteCampaignRequest.builder()- Parameters:
deleteCampaignRequest- AConsumerthat will call methods onDeleteCampaignRequest.Builderto create a request.- Returns:
- Result of the DeleteCampaign operation returned by the service.
- See Also:
-
deleteEmailChannel
default DeleteEmailChannelResponse deleteEmailChannel(DeleteEmailChannelRequest deleteEmailChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException 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.
- See Also:
-
deleteEmailChannel
default DeleteEmailChannelResponse deleteEmailChannel(Consumer<DeleteEmailChannelRequest.Builder> deleteEmailChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Disables the email channel for an application and deletes any existing settings for the channel.
This is a convenience which creates an instance of the
DeleteEmailChannelRequest.Builderavoiding the need to create one manually viaDeleteEmailChannelRequest.builder()- Parameters:
deleteEmailChannelRequest- AConsumerthat will call methods onDeleteEmailChannelRequest.Builderto create a request.- Returns:
- Result of the DeleteEmailChannel operation returned by the service.
- See Also:
-
deleteEmailTemplate
default DeleteEmailTemplateResponse deleteEmailTemplate(DeleteEmailTemplateRequest deleteEmailTemplateRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Deletes a message template for messages that were sent through the email channel.
- Parameters:
deleteEmailTemplateRequest-- Returns:
- Result of the DeleteEmailTemplate operation returned by the service.
- See Also:
-
deleteEmailTemplate
default DeleteEmailTemplateResponse deleteEmailTemplate(Consumer<DeleteEmailTemplateRequest.Builder> deleteEmailTemplateRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Deletes a message template for messages that were sent through the email channel.
This is a convenience which creates an instance of the
DeleteEmailTemplateRequest.Builderavoiding the need to create one manually viaDeleteEmailTemplateRequest.builder()- Parameters:
deleteEmailTemplateRequest- AConsumerthat will call methods onDeleteEmailTemplateRequest.Builderto create a request.- Returns:
- Result of the DeleteEmailTemplate operation returned by the service.
- See Also:
-
deleteEndpoint
default DeleteEndpointResponse deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Deletes an endpoint from an application.
- Parameters:
deleteEndpointRequest-- Returns:
- Result of the DeleteEndpoint operation returned by the service.
- See Also:
-
deleteEndpoint
default DeleteEndpointResponse deleteEndpoint(Consumer<DeleteEndpointRequest.Builder> deleteEndpointRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Deletes an endpoint from an application.
This is a convenience which creates an instance of the
DeleteEndpointRequest.Builderavoiding the need to create one manually viaDeleteEndpointRequest.builder()- Parameters:
deleteEndpointRequest- AConsumerthat will call methods onDeleteEndpointRequest.Builderto create a request.- Returns:
- Result of the DeleteEndpoint operation returned by the service.
- See Also:
-
deleteEventStream
default DeleteEventStreamResponse deleteEventStream(DeleteEventStreamRequest deleteEventStreamRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Deletes the event stream for an application.
- Parameters:
deleteEventStreamRequest-- Returns:
- Result of the DeleteEventStream operation returned by the service.
- See Also:
-
deleteEventStream
default DeleteEventStreamResponse deleteEventStream(Consumer<DeleteEventStreamRequest.Builder> deleteEventStreamRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Deletes the event stream for an application.
This is a convenience which creates an instance of the
DeleteEventStreamRequest.Builderavoiding the need to create one manually viaDeleteEventStreamRequest.builder()- Parameters:
deleteEventStreamRequest- AConsumerthat will call methods onDeleteEventStreamRequest.Builderto create a request.- Returns:
- Result of the DeleteEventStream operation returned by the service.
- See Also:
-
deleteGcmChannel
default DeleteGcmChannelResponse deleteGcmChannel(DeleteGcmChannelRequest deleteGcmChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException 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.
- See Also:
-
deleteGcmChannel
default DeleteGcmChannelResponse deleteGcmChannel(Consumer<DeleteGcmChannelRequest.Builder> deleteGcmChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Disables the GCM channel for an application and deletes any existing settings for the channel.
This is a convenience which creates an instance of the
DeleteGcmChannelRequest.Builderavoiding the need to create one manually viaDeleteGcmChannelRequest.builder()- Parameters:
deleteGcmChannelRequest- AConsumerthat will call methods onDeleteGcmChannelRequest.Builderto create a request.- Returns:
- Result of the DeleteGcmChannel operation returned by the service.
- See Also:
-
deleteInAppTemplate
default DeleteInAppTemplateResponse deleteInAppTemplate(DeleteInAppTemplateRequest deleteInAppTemplateRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Deletes a message template for messages sent using the in-app message channel.
- Parameters:
deleteInAppTemplateRequest-- Returns:
- Result of the DeleteInAppTemplate operation returned by the service.
- See Also:
-
deleteInAppTemplate
default DeleteInAppTemplateResponse deleteInAppTemplate(Consumer<DeleteInAppTemplateRequest.Builder> deleteInAppTemplateRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Deletes a message template for messages sent using the in-app message channel.
This is a convenience which creates an instance of the
DeleteInAppTemplateRequest.Builderavoiding the need to create one manually viaDeleteInAppTemplateRequest.builder()- Parameters:
deleteInAppTemplateRequest- AConsumerthat will call methods onDeleteInAppTemplateRequest.Builderto create a request.- Returns:
- Result of the DeleteInAppTemplate operation returned by the service.
- See Also:
-
deleteJourney
default DeleteJourneyResponse deleteJourney(DeleteJourneyRequest deleteJourneyRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Deletes a journey from an application.
- Parameters:
deleteJourneyRequest-- Returns:
- Result of the DeleteJourney operation returned by the service.
- See Also:
-
deleteJourney
default DeleteJourneyResponse deleteJourney(Consumer<DeleteJourneyRequest.Builder> deleteJourneyRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Deletes a journey from an application.
This is a convenience which creates an instance of the
DeleteJourneyRequest.Builderavoiding the need to create one manually viaDeleteJourneyRequest.builder()- Parameters:
deleteJourneyRequest- AConsumerthat will call methods onDeleteJourneyRequest.Builderto create a request.- Returns:
- Result of the DeleteJourney operation returned by the service.
- See Also:
-
deletePushTemplate
default DeletePushTemplateResponse deletePushTemplate(DeletePushTemplateRequest deletePushTemplateRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Deletes a message template for messages that were sent through a push notification channel.
- Parameters:
deletePushTemplateRequest-- Returns:
- Result of the DeletePushTemplate operation returned by the service.
- See Also:
-
deletePushTemplate
default DeletePushTemplateResponse deletePushTemplate(Consumer<DeletePushTemplateRequest.Builder> deletePushTemplateRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Deletes a message template for messages that were sent through a push notification channel.
This is a convenience which creates an instance of the
DeletePushTemplateRequest.Builderavoiding the need to create one manually viaDeletePushTemplateRequest.builder()- Parameters:
deletePushTemplateRequest- AConsumerthat will call methods onDeletePushTemplateRequest.Builderto create a request.- Returns:
- Result of the DeletePushTemplate operation returned by the service.
- See Also:
-
deleteRecommenderConfiguration
default DeleteRecommenderConfigurationResponse deleteRecommenderConfiguration(DeleteRecommenderConfigurationRequest deleteRecommenderConfigurationRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Deletes an Amazon Pinpoint configuration for a recommender model.
- Parameters:
deleteRecommenderConfigurationRequest-- Returns:
- Result of the DeleteRecommenderConfiguration operation returned by the service.
- See Also:
-
deleteRecommenderConfiguration
default DeleteRecommenderConfigurationResponse deleteRecommenderConfiguration(Consumer<DeleteRecommenderConfigurationRequest.Builder> deleteRecommenderConfigurationRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Deletes an Amazon Pinpoint configuration for a recommender model.
This is a convenience which creates an instance of the
DeleteRecommenderConfigurationRequest.Builderavoiding the need to create one manually viaDeleteRecommenderConfigurationRequest.builder()- Parameters:
deleteRecommenderConfigurationRequest- AConsumerthat will call methods onDeleteRecommenderConfigurationRequest.Builderto create a request.- Returns:
- Result of the DeleteRecommenderConfiguration operation returned by the service.
- See Also:
-
deleteSegment
default DeleteSegmentResponse deleteSegment(DeleteSegmentRequest deleteSegmentRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Deletes a segment from an application.
- Parameters:
deleteSegmentRequest-- Returns:
- Result of the DeleteSegment operation returned by the service.
- See Also:
-
deleteSegment
default DeleteSegmentResponse deleteSegment(Consumer<DeleteSegmentRequest.Builder> deleteSegmentRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Deletes a segment from an application.
This is a convenience which creates an instance of the
DeleteSegmentRequest.Builderavoiding the need to create one manually viaDeleteSegmentRequest.builder()- Parameters:
deleteSegmentRequest- AConsumerthat will call methods onDeleteSegmentRequest.Builderto create a request.- Returns:
- Result of the DeleteSegment operation returned by the service.
- See Also:
-
deleteSmsChannel
default DeleteSmsChannelResponse deleteSmsChannel(DeleteSmsChannelRequest deleteSmsChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException 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.
- See Also:
-
deleteSmsChannel
default DeleteSmsChannelResponse deleteSmsChannel(Consumer<DeleteSmsChannelRequest.Builder> deleteSmsChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Disables the SMS channel for an application and deletes any existing settings for the channel.
This is a convenience which creates an instance of the
DeleteSmsChannelRequest.Builderavoiding the need to create one manually viaDeleteSmsChannelRequest.builder()- Parameters:
deleteSmsChannelRequest- AConsumerthat will call methods onDeleteSmsChannelRequest.Builderto create a request.- Returns:
- Result of the DeleteSmsChannel operation returned by the service.
- See Also:
-
deleteSmsTemplate
default DeleteSmsTemplateResponse deleteSmsTemplate(DeleteSmsTemplateRequest deleteSmsTemplateRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Deletes a message template for messages that were sent through the SMS channel.
- Parameters:
deleteSmsTemplateRequest-- Returns:
- Result of the DeleteSmsTemplate operation returned by the service.
- See Also:
-
deleteSmsTemplate
default DeleteSmsTemplateResponse deleteSmsTemplate(Consumer<DeleteSmsTemplateRequest.Builder> deleteSmsTemplateRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Deletes a message template for messages that were sent through the SMS channel.
This is a convenience which creates an instance of the
DeleteSmsTemplateRequest.Builderavoiding the need to create one manually viaDeleteSmsTemplateRequest.builder()- Parameters:
deleteSmsTemplateRequest- AConsumerthat will call methods onDeleteSmsTemplateRequest.Builderto create a request.- Returns:
- Result of the DeleteSmsTemplate operation returned by the service.
- See Also:
-
deleteUserEndpoints
default DeleteUserEndpointsResponse deleteUserEndpoints(DeleteUserEndpointsRequest deleteUserEndpointsRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Deletes all the endpoints that are associated with a specific user ID.
- Parameters:
deleteUserEndpointsRequest-- Returns:
- Result of the DeleteUserEndpoints operation returned by the service.
- See Also:
-
deleteUserEndpoints
default DeleteUserEndpointsResponse deleteUserEndpoints(Consumer<DeleteUserEndpointsRequest.Builder> deleteUserEndpointsRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Deletes all the endpoints that are associated with a specific user ID.
This is a convenience which creates an instance of the
DeleteUserEndpointsRequest.Builderavoiding the need to create one manually viaDeleteUserEndpointsRequest.builder()- Parameters:
deleteUserEndpointsRequest- AConsumerthat will call methods onDeleteUserEndpointsRequest.Builderto create a request.- Returns:
- Result of the DeleteUserEndpoints operation returned by the service.
- See Also:
-
deleteVoiceChannel
default DeleteVoiceChannelResponse deleteVoiceChannel(DeleteVoiceChannelRequest deleteVoiceChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException 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.
- See Also:
-
deleteVoiceChannel
default DeleteVoiceChannelResponse deleteVoiceChannel(Consumer<DeleteVoiceChannelRequest.Builder> deleteVoiceChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Disables the voice channel for an application and deletes any existing settings for the channel.
This is a convenience which creates an instance of the
DeleteVoiceChannelRequest.Builderavoiding the need to create one manually viaDeleteVoiceChannelRequest.builder()- Parameters:
deleteVoiceChannelRequest- AConsumerthat will call methods onDeleteVoiceChannelRequest.Builderto create a request.- Returns:
- Result of the DeleteVoiceChannel operation returned by the service.
- See Also:
-
deleteVoiceTemplate
default DeleteVoiceTemplateResponse deleteVoiceTemplate(DeleteVoiceTemplateRequest deleteVoiceTemplateRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Deletes a message template for messages that were sent through the voice channel.
- Parameters:
deleteVoiceTemplateRequest-- Returns:
- Result of the DeleteVoiceTemplate operation returned by the service.
- See Also:
-
deleteVoiceTemplate
default DeleteVoiceTemplateResponse deleteVoiceTemplate(Consumer<DeleteVoiceTemplateRequest.Builder> deleteVoiceTemplateRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Deletes a message template for messages that were sent through the voice channel.
This is a convenience which creates an instance of the
DeleteVoiceTemplateRequest.Builderavoiding the need to create one manually viaDeleteVoiceTemplateRequest.builder()- Parameters:
deleteVoiceTemplateRequest- AConsumerthat will call methods onDeleteVoiceTemplateRequest.Builderto create a request.- Returns:
- Result of the DeleteVoiceTemplate operation returned by the service.
- See Also:
-
getAdmChannel
default GetAdmChannelResponse getAdmChannel(GetAdmChannelRequest getAdmChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException 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.
- See Also:
-
getAdmChannel
default GetAdmChannelResponse getAdmChannel(Consumer<GetAdmChannelRequest.Builder> getAdmChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about the status and settings of the ADM channel for an application.
This is a convenience which creates an instance of the
GetAdmChannelRequest.Builderavoiding the need to create one manually viaGetAdmChannelRequest.builder()- Parameters:
getAdmChannelRequest- AConsumerthat will call methods onGetAdmChannelRequest.Builderto create a request.- Returns:
- Result of the GetAdmChannel operation returned by the service.
- See Also:
-
getApnsChannel
default GetApnsChannelResponse getApnsChannel(GetApnsChannelRequest getApnsChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException 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.
- See Also:
-
getApnsChannel
default GetApnsChannelResponse getApnsChannel(Consumer<GetApnsChannelRequest.Builder> getApnsChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about the status and settings of the APNs channel for an application.
This is a convenience which creates an instance of the
GetApnsChannelRequest.Builderavoiding the need to create one manually viaGetApnsChannelRequest.builder()- Parameters:
getApnsChannelRequest- AConsumerthat will call methods onGetApnsChannelRequest.Builderto create a request.- Returns:
- Result of the GetApnsChannel operation returned by the service.
- See Also:
-
getApnsSandboxChannel
default GetApnsSandboxChannelResponse getApnsSandboxChannel(GetApnsSandboxChannelRequest getApnsSandboxChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException 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.
- See Also:
-
getApnsSandboxChannel
default GetApnsSandboxChannelResponse getApnsSandboxChannel(Consumer<GetApnsSandboxChannelRequest.Builder> getApnsSandboxChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about the status and settings of the APNs sandbox channel for an application.
This is a convenience which creates an instance of the
GetApnsSandboxChannelRequest.Builderavoiding the need to create one manually viaGetApnsSandboxChannelRequest.builder()- Parameters:
getApnsSandboxChannelRequest- AConsumerthat will call methods onGetApnsSandboxChannelRequest.Builderto create a request.- Returns:
- Result of the GetApnsSandboxChannel operation returned by the service.
- See Also:
-
getApnsVoipChannel
default GetApnsVoipChannelResponse getApnsVoipChannel(GetApnsVoipChannelRequest getApnsVoipChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException 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.
- See Also:
-
getApnsVoipChannel
default GetApnsVoipChannelResponse getApnsVoipChannel(Consumer<GetApnsVoipChannelRequest.Builder> getApnsVoipChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about the status and settings of the APNs VoIP channel for an application.
This is a convenience which creates an instance of the
GetApnsVoipChannelRequest.Builderavoiding the need to create one manually viaGetApnsVoipChannelRequest.builder()- Parameters:
getApnsVoipChannelRequest- AConsumerthat will call methods onGetApnsVoipChannelRequest.Builderto create a request.- Returns:
- Result of the GetApnsVoipChannel operation returned by the service.
- See Also:
-
getApnsVoipSandboxChannel
default GetApnsVoipSandboxChannelResponse getApnsVoipSandboxChannel(GetApnsVoipSandboxChannelRequest getApnsVoipSandboxChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException 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.
- See Also:
-
getApnsVoipSandboxChannel
default GetApnsVoipSandboxChannelResponse getApnsVoipSandboxChannel(Consumer<GetApnsVoipSandboxChannelRequest.Builder> getApnsVoipSandboxChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about the status and settings of the APNs VoIP sandbox channel for an application.
This is a convenience which creates an instance of the
GetApnsVoipSandboxChannelRequest.Builderavoiding the need to create one manually viaGetApnsVoipSandboxChannelRequest.builder()- Parameters:
getApnsVoipSandboxChannelRequest- AConsumerthat will call methods onGetApnsVoipSandboxChannelRequest.Builderto create a request.- Returns:
- Result of the GetApnsVoipSandboxChannel operation returned by the service.
- See Also:
-
getApp
default GetAppResponse getApp(GetAppRequest getAppRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about an application.
- Parameters:
getAppRequest-- Returns:
- Result of the GetApp operation returned by the service.
- See Also:
-
getApp
default GetAppResponse getApp(Consumer<GetAppRequest.Builder> getAppRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about an application.
This is a convenience which creates an instance of the
GetAppRequest.Builderavoiding the need to create one manually viaGetAppRequest.builder()- Parameters:
getAppRequest- AConsumerthat will call methods onGetAppRequest.Builderto create a request.- Returns:
- Result of the GetApp operation returned by the service.
- See Also:
-
getApplicationDateRangeKpi
default GetApplicationDateRangeKpiResponse getApplicationDateRangeKpi(GetApplicationDateRangeKpiRequest getApplicationDateRangeKpiRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException 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.
- See Also:
-
getApplicationDateRangeKpi
default GetApplicationDateRangeKpiResponse getApplicationDateRangeKpi(Consumer<GetApplicationDateRangeKpiRequest.Builder> getApplicationDateRangeKpiRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves (queries) pre-aggregated data for a standard metric that applies to an application.
This is a convenience which creates an instance of the
GetApplicationDateRangeKpiRequest.Builderavoiding the need to create one manually viaGetApplicationDateRangeKpiRequest.builder()- Parameters:
getApplicationDateRangeKpiRequest- AConsumerthat will call methods onGetApplicationDateRangeKpiRequest.Builderto create a request.- Returns:
- Result of the GetApplicationDateRangeKpi operation returned by the service.
- See Also:
-
getApplicationSettings
default GetApplicationSettingsResponse getApplicationSettings(GetApplicationSettingsRequest getApplicationSettingsRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about the settings for an application.
- Parameters:
getApplicationSettingsRequest-- Returns:
- Result of the GetApplicationSettings operation returned by the service.
- See Also:
-
getApplicationSettings
default GetApplicationSettingsResponse getApplicationSettings(Consumer<GetApplicationSettingsRequest.Builder> getApplicationSettingsRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about the settings for an application.
This is a convenience which creates an instance of the
GetApplicationSettingsRequest.Builderavoiding the need to create one manually viaGetApplicationSettingsRequest.builder()- Parameters:
getApplicationSettingsRequest- AConsumerthat will call methods onGetApplicationSettingsRequest.Builderto create a request.- Returns:
- Result of the GetApplicationSettings operation returned by the service.
- See Also:
-
getApps
default GetAppsResponse getApps(GetAppsRequest getAppsRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about all the applications that are associated with your Amazon Pinpoint account.
- Parameters:
getAppsRequest-- Returns:
- Result of the GetApps operation returned by the service.
- See Also:
-
getApps
default GetAppsResponse getApps(Consumer<GetAppsRequest.Builder> getAppsRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about all the applications that are associated with your Amazon Pinpoint account.
This is a convenience which creates an instance of the
GetAppsRequest.Builderavoiding the need to create one manually viaGetAppsRequest.builder()- Parameters:
getAppsRequest- AConsumerthat will call methods onGetAppsRequest.Builderto create a request.- Returns:
- Result of the GetApps operation returned by the service.
- See Also:
-
getBaiduChannel
default GetBaiduChannelResponse getBaiduChannel(GetBaiduChannelRequest getBaiduChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about the status and settings of the Baidu channel for an application.
- Parameters:
getBaiduChannelRequest-- Returns:
- Result of the GetBaiduChannel operation returned by the service.
- See Also:
-
getBaiduChannel
default GetBaiduChannelResponse getBaiduChannel(Consumer<GetBaiduChannelRequest.Builder> getBaiduChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about the status and settings of the Baidu channel for an application.
This is a convenience which creates an instance of the
GetBaiduChannelRequest.Builderavoiding the need to create one manually viaGetBaiduChannelRequest.builder()- Parameters:
getBaiduChannelRequest- AConsumerthat will call methods onGetBaiduChannelRequest.Builderto create a request.- Returns:
- Result of the GetBaiduChannel operation returned by the service.
- See Also:
-
getCampaign
default GetCampaignResponse getCampaign(GetCampaignRequest getCampaignRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about the status, configuration, and other settings for a campaign.
- Parameters:
getCampaignRequest-- Returns:
- Result of the GetCampaign operation returned by the service.
- See Also:
-
getCampaign
default GetCampaignResponse getCampaign(Consumer<GetCampaignRequest.Builder> getCampaignRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about the status, configuration, and other settings for a campaign.
This is a convenience which creates an instance of the
GetCampaignRequest.Builderavoiding the need to create one manually viaGetCampaignRequest.builder()- Parameters:
getCampaignRequest- AConsumerthat will call methods onGetCampaignRequest.Builderto create a request.- Returns:
- Result of the GetCampaign operation returned by the service.
- See Also:
-
getCampaignActivities
default GetCampaignActivitiesResponse getCampaignActivities(GetCampaignActivitiesRequest getCampaignActivitiesRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about all the activities for a campaign.
- Parameters:
getCampaignActivitiesRequest-- Returns:
- Result of the GetCampaignActivities operation returned by the service.
- See Also:
-
getCampaignActivities
default GetCampaignActivitiesResponse getCampaignActivities(Consumer<GetCampaignActivitiesRequest.Builder> getCampaignActivitiesRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about all the activities for a campaign.
This is a convenience which creates an instance of the
GetCampaignActivitiesRequest.Builderavoiding the need to create one manually viaGetCampaignActivitiesRequest.builder()- Parameters:
getCampaignActivitiesRequest- AConsumerthat will call methods onGetCampaignActivitiesRequest.Builderto create a request.- Returns:
- Result of the GetCampaignActivities operation returned by the service.
- See Also:
-
getCampaignDateRangeKpi
default GetCampaignDateRangeKpiResponse getCampaignDateRangeKpi(GetCampaignDateRangeKpiRequest getCampaignDateRangeKpiRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException 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.
- See Also:
-
getCampaignDateRangeKpi
default GetCampaignDateRangeKpiResponse getCampaignDateRangeKpi(Consumer<GetCampaignDateRangeKpiRequest.Builder> getCampaignDateRangeKpiRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign.
This is a convenience which creates an instance of the
GetCampaignDateRangeKpiRequest.Builderavoiding the need to create one manually viaGetCampaignDateRangeKpiRequest.builder()- Parameters:
getCampaignDateRangeKpiRequest- AConsumerthat will call methods onGetCampaignDateRangeKpiRequest.Builderto create a request.- Returns:
- Result of the GetCampaignDateRangeKpi operation returned by the service.
- See Also:
-
getCampaignVersion
default GetCampaignVersionResponse getCampaignVersion(GetCampaignVersionRequest getCampaignVersionRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException 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.
- See Also:
-
getCampaignVersion
default GetCampaignVersionResponse getCampaignVersion(Consumer<GetCampaignVersionRequest.Builder> getCampaignVersionRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about the status, configuration, and other settings for a specific version of a campaign.
This is a convenience which creates an instance of the
GetCampaignVersionRequest.Builderavoiding the need to create one manually viaGetCampaignVersionRequest.builder()- Parameters:
getCampaignVersionRequest- AConsumerthat will call methods onGetCampaignVersionRequest.Builderto create a request.- Returns:
- Result of the GetCampaignVersion operation returned by the service.
- See Also:
-
getCampaignVersions
default GetCampaignVersionsResponse getCampaignVersions(GetCampaignVersionsRequest getCampaignVersionsRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about the status, configuration, and other settings for all versions of a campaign.
- Parameters:
getCampaignVersionsRequest-- Returns:
- Result of the GetCampaignVersions operation returned by the service.
- See Also:
-
getCampaignVersions
default GetCampaignVersionsResponse getCampaignVersions(Consumer<GetCampaignVersionsRequest.Builder> getCampaignVersionsRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about the status, configuration, and other settings for all versions of a campaign.
This is a convenience which creates an instance of the
GetCampaignVersionsRequest.Builderavoiding the need to create one manually viaGetCampaignVersionsRequest.builder()- Parameters:
getCampaignVersionsRequest- AConsumerthat will call methods onGetCampaignVersionsRequest.Builderto create a request.- Returns:
- Result of the GetCampaignVersions operation returned by the service.
- See Also:
-
getCampaigns
default GetCampaignsResponse getCampaigns(GetCampaignsRequest getCampaignsRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException 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.
- See Also:
-
getCampaigns
default GetCampaignsResponse getCampaigns(Consumer<GetCampaignsRequest.Builder> getCampaignsRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application.
This is a convenience which creates an instance of the
GetCampaignsRequest.Builderavoiding the need to create one manually viaGetCampaignsRequest.builder()- Parameters:
getCampaignsRequest- AConsumerthat will call methods onGetCampaignsRequest.Builderto create a request.- Returns:
- Result of the GetCampaigns operation returned by the service.
- See Also:
-
getChannels
default GetChannelsResponse getChannels(GetChannelsRequest getChannelsRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException 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.
- See Also:
-
getChannels
default GetChannelsResponse getChannels(Consumer<GetChannelsRequest.Builder> getChannelsRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about the history and status of each channel for an application.
This is a convenience which creates an instance of the
GetChannelsRequest.Builderavoiding the need to create one manually viaGetChannelsRequest.builder()- Parameters:
getChannelsRequest- AConsumerthat will call methods onGetChannelsRequest.Builderto create a request.- Returns:
- Result of the GetChannels operation returned by the service.
- See Also:
-
getEmailChannel
default GetEmailChannelResponse getEmailChannel(GetEmailChannelRequest getEmailChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException 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.
- See Also:
-
getEmailChannel
default GetEmailChannelResponse getEmailChannel(Consumer<GetEmailChannelRequest.Builder> getEmailChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about the status and settings of the email channel for an application.
This is a convenience which creates an instance of the
GetEmailChannelRequest.Builderavoiding the need to create one manually viaGetEmailChannelRequest.builder()- Parameters:
getEmailChannelRequest- AConsumerthat will call methods onGetEmailChannelRequest.Builderto create a request.- Returns:
- Result of the GetEmailChannel operation returned by the service.
- See Also:
-
getEmailTemplate
default GetEmailTemplateResponse getEmailTemplate(GetEmailTemplateRequest getEmailTemplateRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves the content and settings of a message template for messages that are sent through the email channel.
- Parameters:
getEmailTemplateRequest-- Returns:
- Result of the GetEmailTemplate operation returned by the service.
- See Also:
-
getEmailTemplate
default GetEmailTemplateResponse getEmailTemplate(Consumer<GetEmailTemplateRequest.Builder> getEmailTemplateRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves the content and settings of a message template for messages that are sent through the email channel.
This is a convenience which creates an instance of the
GetEmailTemplateRequest.Builderavoiding the need to create one manually viaGetEmailTemplateRequest.builder()- Parameters:
getEmailTemplateRequest- AConsumerthat will call methods onGetEmailTemplateRequest.Builderto create a request.- Returns:
- Result of the GetEmailTemplate operation returned by the service.
- See Also:
-
getEndpoint
default GetEndpointResponse getEndpoint(GetEndpointRequest getEndpointRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException 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.
- See Also:
-
getEndpoint
default GetEndpointResponse getEndpoint(Consumer<GetEndpointRequest.Builder> getEndpointRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about the settings and attributes of a specific endpoint for an application.
This is a convenience which creates an instance of the
GetEndpointRequest.Builderavoiding the need to create one manually viaGetEndpointRequest.builder()- Parameters:
getEndpointRequest- AConsumerthat will call methods onGetEndpointRequest.Builderto create a request.- Returns:
- Result of the GetEndpoint operation returned by the service.
- See Also:
-
getEventStream
default GetEventStreamResponse getEventStream(GetEventStreamRequest getEventStreamRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about the event stream settings for an application.
- Parameters:
getEventStreamRequest-- Returns:
- Result of the GetEventStream operation returned by the service.
- See Also:
-
getEventStream
default GetEventStreamResponse getEventStream(Consumer<GetEventStreamRequest.Builder> getEventStreamRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about the event stream settings for an application.
This is a convenience which creates an instance of the
GetEventStreamRequest.Builderavoiding the need to create one manually viaGetEventStreamRequest.builder()- Parameters:
getEventStreamRequest- AConsumerthat will call methods onGetEventStreamRequest.Builderto create a request.- Returns:
- Result of the GetEventStream operation returned by the service.
- See Also:
-
getExportJob
default GetExportJobResponse getExportJob(GetExportJobRequest getExportJobRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException 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.
- See Also:
-
getExportJob
default GetExportJobResponse getExportJob(Consumer<GetExportJobRequest.Builder> getExportJobRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about the status and settings of a specific export job for an application.
This is a convenience which creates an instance of the
GetExportJobRequest.Builderavoiding the need to create one manually viaGetExportJobRequest.builder()- Parameters:
getExportJobRequest- AConsumerthat will call methods onGetExportJobRequest.Builderto create a request.- Returns:
- Result of the GetExportJob operation returned by the service.
- See Also:
-
getExportJobs
default GetExportJobsResponse getExportJobs(GetExportJobsRequest getExportJobsRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException 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.
- See Also:
-
getExportJobs
default GetExportJobsResponse getExportJobs(Consumer<GetExportJobsRequest.Builder> getExportJobsRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about the status and settings of all the export jobs for an application.
This is a convenience which creates an instance of the
GetExportJobsRequest.Builderavoiding the need to create one manually viaGetExportJobsRequest.builder()- Parameters:
getExportJobsRequest- AConsumerthat will call methods onGetExportJobsRequest.Builderto create a request.- Returns:
- Result of the GetExportJobs operation returned by the service.
- See Also:
-
getGcmChannel
default GetGcmChannelResponse getGcmChannel(GetGcmChannelRequest getGcmChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException 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.
- See Also:
-
getGcmChannel
default GetGcmChannelResponse getGcmChannel(Consumer<GetGcmChannelRequest.Builder> getGcmChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about the status and settings of the GCM channel for an application.
This is a convenience which creates an instance of the
GetGcmChannelRequest.Builderavoiding the need to create one manually viaGetGcmChannelRequest.builder()- Parameters:
getGcmChannelRequest- AConsumerthat will call methods onGetGcmChannelRequest.Builderto create a request.- Returns:
- Result of the GetGcmChannel operation returned by the service.
- See Also:
-
getImportJob
default GetImportJobResponse getImportJob(GetImportJobRequest getImportJobRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException 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.
- See Also:
-
getImportJob
default GetImportJobResponse getImportJob(Consumer<GetImportJobRequest.Builder> getImportJobRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about the status and settings of a specific import job for an application.
This is a convenience which creates an instance of the
GetImportJobRequest.Builderavoiding the need to create one manually viaGetImportJobRequest.builder()- Parameters:
getImportJobRequest- AConsumerthat will call methods onGetImportJobRequest.Builderto create a request.- Returns:
- Result of the GetImportJob operation returned by the service.
- See Also:
-
getImportJobs
default GetImportJobsResponse getImportJobs(GetImportJobsRequest getImportJobsRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException 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.
- See Also:
-
getImportJobs
default GetImportJobsResponse getImportJobs(Consumer<GetImportJobsRequest.Builder> getImportJobsRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about the status and settings of all the import jobs for an application.
This is a convenience which creates an instance of the
GetImportJobsRequest.Builderavoiding the need to create one manually viaGetImportJobsRequest.builder()- Parameters:
getImportJobsRequest- AConsumerthat will call methods onGetImportJobsRequest.Builderto create a request.- Returns:
- Result of the GetImportJobs operation returned by the service.
- See Also:
-
getInAppMessages
default GetInAppMessagesResponse getInAppMessages(GetInAppMessagesRequest getInAppMessagesRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves the in-app messages targeted for the provided endpoint ID.
- Parameters:
getInAppMessagesRequest-- Returns:
- Result of the GetInAppMessages operation returned by the service.
- See Also:
-
getInAppMessages
default GetInAppMessagesResponse getInAppMessages(Consumer<GetInAppMessagesRequest.Builder> getInAppMessagesRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves the in-app messages targeted for the provided endpoint ID.
This is a convenience which creates an instance of the
GetInAppMessagesRequest.Builderavoiding the need to create one manually viaGetInAppMessagesRequest.builder()- Parameters:
getInAppMessagesRequest- AConsumerthat will call methods onGetInAppMessagesRequest.Builderto create a request.- Returns:
- Result of the GetInAppMessages operation returned by the service.
- See Also:
-
getInAppTemplate
default GetInAppTemplateResponse getInAppTemplate(GetInAppTemplateRequest getInAppTemplateRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves the content and settings of a message template for messages sent through the in-app channel.
- Parameters:
getInAppTemplateRequest-- Returns:
- Result of the GetInAppTemplate operation returned by the service.
- See Also:
-
getInAppTemplate
default GetInAppTemplateResponse getInAppTemplate(Consumer<GetInAppTemplateRequest.Builder> getInAppTemplateRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves the content and settings of a message template for messages sent through the in-app channel.
This is a convenience which creates an instance of the
GetInAppTemplateRequest.Builderavoiding the need to create one manually viaGetInAppTemplateRequest.builder()- Parameters:
getInAppTemplateRequest- AConsumerthat will call methods onGetInAppTemplateRequest.Builderto create a request.- Returns:
- Result of the GetInAppTemplate operation returned by the service.
- See Also:
-
getJourney
default GetJourneyResponse getJourney(GetJourneyRequest getJourneyRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about the status, configuration, and other settings for a journey.
- Parameters:
getJourneyRequest-- Returns:
- Result of the GetJourney operation returned by the service.
- See Also:
-
getJourney
default GetJourneyResponse getJourney(Consumer<GetJourneyRequest.Builder> getJourneyRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about the status, configuration, and other settings for a journey.
This is a convenience which creates an instance of the
GetJourneyRequest.Builderavoiding the need to create one manually viaGetJourneyRequest.builder()- Parameters:
getJourneyRequest- AConsumerthat will call methods onGetJourneyRequest.Builderto create a request.- Returns:
- Result of the GetJourney operation returned by the service.
- See Also:
-
getJourneyDateRangeKpi
default GetJourneyDateRangeKpiResponse getJourneyDateRangeKpi(GetJourneyDateRangeKpiRequest getJourneyDateRangeKpiRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves (queries) pre-aggregated data for a standard engagement metric that applies to a journey.
- Parameters:
getJourneyDateRangeKpiRequest-- Returns:
- Result of the GetJourneyDateRangeKpi operation returned by the service.
- See Also:
-
getJourneyDateRangeKpi
default GetJourneyDateRangeKpiResponse getJourneyDateRangeKpi(Consumer<GetJourneyDateRangeKpiRequest.Builder> getJourneyDateRangeKpiRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves (queries) pre-aggregated data for a standard engagement metric that applies to a journey.
This is a convenience which creates an instance of the
GetJourneyDateRangeKpiRequest.Builderavoiding the need to create one manually viaGetJourneyDateRangeKpiRequest.builder()- Parameters:
getJourneyDateRangeKpiRequest- AConsumerthat will call methods onGetJourneyDateRangeKpiRequest.Builderto create a request.- Returns:
- Result of the GetJourneyDateRangeKpi operation returned by the service.
- See Also:
-
getJourneyExecutionActivityMetrics
default GetJourneyExecutionActivityMetricsResponse getJourneyExecutionActivityMetrics(GetJourneyExecutionActivityMetricsRequest getJourneyExecutionActivityMetricsRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey activity.
- Parameters:
getJourneyExecutionActivityMetricsRequest-- Returns:
- Result of the GetJourneyExecutionActivityMetrics operation returned by the service.
- See Also:
-
getJourneyExecutionActivityMetrics
default GetJourneyExecutionActivityMetricsResponse getJourneyExecutionActivityMetrics(Consumer<GetJourneyExecutionActivityMetricsRequest.Builder> getJourneyExecutionActivityMetricsRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey activity.
This is a convenience which creates an instance of the
GetJourneyExecutionActivityMetricsRequest.Builderavoiding the need to create one manually viaGetJourneyExecutionActivityMetricsRequest.builder()- Parameters:
getJourneyExecutionActivityMetricsRequest- AConsumerthat will call methods onGetJourneyExecutionActivityMetricsRequest.Builderto create a request.- Returns:
- Result of the GetJourneyExecutionActivityMetrics operation returned by the service.
- See Also:
-
getJourneyExecutionMetrics
default GetJourneyExecutionMetricsResponse getJourneyExecutionMetrics(GetJourneyExecutionMetricsRequest getJourneyExecutionMetricsRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey.
- Parameters:
getJourneyExecutionMetricsRequest-- Returns:
- Result of the GetJourneyExecutionMetrics operation returned by the service.
- See Also:
-
getJourneyExecutionMetrics
default GetJourneyExecutionMetricsResponse getJourneyExecutionMetrics(Consumer<GetJourneyExecutionMetricsRequest.Builder> getJourneyExecutionMetricsRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey.
This is a convenience which creates an instance of the
GetJourneyExecutionMetricsRequest.Builderavoiding the need to create one manually viaGetJourneyExecutionMetricsRequest.builder()- Parameters:
getJourneyExecutionMetricsRequest- AConsumerthat will call methods onGetJourneyExecutionMetricsRequest.Builderto create a request.- Returns:
- Result of the GetJourneyExecutionMetrics operation returned by the service.
- See Also:
-
getJourneyRunExecutionActivityMetrics
default GetJourneyRunExecutionActivityMetricsResponse getJourneyRunExecutionActivityMetrics(GetJourneyRunExecutionActivityMetricsRequest getJourneyRunExecutionActivityMetricsRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey activity.
- Parameters:
getJourneyRunExecutionActivityMetricsRequest-- Returns:
- Result of the GetJourneyRunExecutionActivityMetrics operation returned by the service.
- See Also:
-
getJourneyRunExecutionActivityMetrics
default GetJourneyRunExecutionActivityMetricsResponse getJourneyRunExecutionActivityMetrics(Consumer<GetJourneyRunExecutionActivityMetricsRequest.Builder> getJourneyRunExecutionActivityMetricsRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey activity.
This is a convenience which creates an instance of the
GetJourneyRunExecutionActivityMetricsRequest.Builderavoiding the need to create one manually viaGetJourneyRunExecutionActivityMetricsRequest.builder()- Parameters:
getJourneyRunExecutionActivityMetricsRequest- AConsumerthat will call methods onGetJourneyRunExecutionActivityMetricsRequest.Builderto create a request.- Returns:
- Result of the GetJourneyRunExecutionActivityMetrics operation returned by the service.
- See Also:
-
getJourneyRunExecutionMetrics
default GetJourneyRunExecutionMetricsResponse getJourneyRunExecutionMetrics(GetJourneyRunExecutionMetricsRequest getJourneyRunExecutionMetricsRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey.
- Parameters:
getJourneyRunExecutionMetricsRequest-- Returns:
- Result of the GetJourneyRunExecutionMetrics operation returned by the service.
- See Also:
-
getJourneyRunExecutionMetrics
default GetJourneyRunExecutionMetricsResponse getJourneyRunExecutionMetrics(Consumer<GetJourneyRunExecutionMetricsRequest.Builder> getJourneyRunExecutionMetricsRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey.
This is a convenience which creates an instance of the
GetJourneyRunExecutionMetricsRequest.Builderavoiding the need to create one manually viaGetJourneyRunExecutionMetricsRequest.builder()- Parameters:
getJourneyRunExecutionMetricsRequest- AConsumerthat will call methods onGetJourneyRunExecutionMetricsRequest.Builderto create a request.- Returns:
- Result of the GetJourneyRunExecutionMetrics operation returned by the service.
- See Also:
-
getJourneyRuns
default GetJourneyRunsResponse getJourneyRuns(GetJourneyRunsRequest getJourneyRunsRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Provides information about the runs of a journey.
- Parameters:
getJourneyRunsRequest-- Returns:
- Result of the GetJourneyRuns operation returned by the service.
- See Also:
-
getJourneyRuns
default GetJourneyRunsResponse getJourneyRuns(Consumer<GetJourneyRunsRequest.Builder> getJourneyRunsRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Provides information about the runs of a journey.
This is a convenience which creates an instance of the
GetJourneyRunsRequest.Builderavoiding the need to create one manually viaGetJourneyRunsRequest.builder()- Parameters:
getJourneyRunsRequest- AConsumerthat will call methods onGetJourneyRunsRequest.Builderto create a request.- Returns:
- Result of the GetJourneyRuns operation returned by the service.
- See Also:
-
getPushTemplate
default GetPushTemplateResponse getPushTemplate(GetPushTemplateRequest getPushTemplateRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves the content and settings of a message template for messages that are sent through a push notification channel.
- Parameters:
getPushTemplateRequest-- Returns:
- Result of the GetPushTemplate operation returned by the service.
- See Also:
-
getPushTemplate
default GetPushTemplateResponse getPushTemplate(Consumer<GetPushTemplateRequest.Builder> getPushTemplateRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves the content and settings of a message template for messages that are sent through a push notification channel.
This is a convenience which creates an instance of the
GetPushTemplateRequest.Builderavoiding the need to create one manually viaGetPushTemplateRequest.builder()- Parameters:
getPushTemplateRequest- AConsumerthat will call methods onGetPushTemplateRequest.Builderto create a request.- Returns:
- Result of the GetPushTemplate operation returned by the service.
- See Also:
-
getRecommenderConfiguration
default GetRecommenderConfigurationResponse getRecommenderConfiguration(GetRecommenderConfigurationRequest getRecommenderConfigurationRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about an Amazon Pinpoint configuration for a recommender model.
- Parameters:
getRecommenderConfigurationRequest-- Returns:
- Result of the GetRecommenderConfiguration operation returned by the service.
- See Also:
-
getRecommenderConfiguration
default GetRecommenderConfigurationResponse getRecommenderConfiguration(Consumer<GetRecommenderConfigurationRequest.Builder> getRecommenderConfigurationRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about an Amazon Pinpoint configuration for a recommender model.
This is a convenience which creates an instance of the
GetRecommenderConfigurationRequest.Builderavoiding the need to create one manually viaGetRecommenderConfigurationRequest.builder()- Parameters:
getRecommenderConfigurationRequest- AConsumerthat will call methods onGetRecommenderConfigurationRequest.Builderto create a request.- Returns:
- Result of the GetRecommenderConfiguration operation returned by the service.
- See Also:
-
getRecommenderConfigurations
default GetRecommenderConfigurationsResponse getRecommenderConfigurations(GetRecommenderConfigurationsRequest getRecommenderConfigurationsRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about all the recommender model configurations that are associated with your Amazon Pinpoint account.
- Parameters:
getRecommenderConfigurationsRequest-- Returns:
- Result of the GetRecommenderConfigurations operation returned by the service.
- See Also:
-
getRecommenderConfigurations
default GetRecommenderConfigurationsResponse getRecommenderConfigurations(Consumer<GetRecommenderConfigurationsRequest.Builder> getRecommenderConfigurationsRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about all the recommender model configurations that are associated with your Amazon Pinpoint account.
This is a convenience which creates an instance of the
GetRecommenderConfigurationsRequest.Builderavoiding the need to create one manually viaGetRecommenderConfigurationsRequest.builder()- Parameters:
getRecommenderConfigurationsRequest- AConsumerthat will call methods onGetRecommenderConfigurationsRequest.Builderto create a request.- Returns:
- Result of the GetRecommenderConfigurations operation returned by the service.
- See Also:
-
getSegment
default GetSegmentResponse getSegment(GetSegmentRequest getSegmentRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException 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.
- See Also:
-
getSegment
default GetSegmentResponse getSegment(Consumer<GetSegmentRequest.Builder> getSegmentRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about the configuration, dimension, and other settings for a specific segment that's associated with an application.
This is a convenience which creates an instance of the
GetSegmentRequest.Builderavoiding the need to create one manually viaGetSegmentRequest.builder()- Parameters:
getSegmentRequest- AConsumerthat will call methods onGetSegmentRequest.Builderto create a request.- Returns:
- Result of the GetSegment operation returned by the service.
- See Also:
-
getSegmentExportJobs
default GetSegmentExportJobsResponse getSegmentExportJobs(GetSegmentExportJobsRequest getSegmentExportJobsRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException 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.
- See Also:
-
getSegmentExportJobs
default GetSegmentExportJobsResponse getSegmentExportJobs(Consumer<GetSegmentExportJobsRequest.Builder> getSegmentExportJobsRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about the status and settings of the export jobs for a segment.
This is a convenience which creates an instance of the
GetSegmentExportJobsRequest.Builderavoiding the need to create one manually viaGetSegmentExportJobsRequest.builder()- Parameters:
getSegmentExportJobsRequest- AConsumerthat will call methods onGetSegmentExportJobsRequest.Builderto create a request.- Returns:
- Result of the GetSegmentExportJobs operation returned by the service.
- See Also:
-
getSegmentImportJobs
default GetSegmentImportJobsResponse getSegmentImportJobs(GetSegmentImportJobsRequest getSegmentImportJobsRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException 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.
- See Also:
-
getSegmentImportJobs
default GetSegmentImportJobsResponse getSegmentImportJobs(Consumer<GetSegmentImportJobsRequest.Builder> getSegmentImportJobsRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about the status and settings of the import jobs for a segment.
This is a convenience which creates an instance of the
GetSegmentImportJobsRequest.Builderavoiding the need to create one manually viaGetSegmentImportJobsRequest.builder()- Parameters:
getSegmentImportJobsRequest- AConsumerthat will call methods onGetSegmentImportJobsRequest.Builderto create a request.- Returns:
- Result of the GetSegmentImportJobs operation returned by the service.
- See Also:
-
getSegmentVersion
default GetSegmentVersionResponse getSegmentVersion(GetSegmentVersionRequest getSegmentVersionRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException 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.
- See Also:
-
getSegmentVersion
default GetSegmentVersionResponse getSegmentVersion(Consumer<GetSegmentVersionRequest.Builder> getSegmentVersionRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about the configuration, dimension, and other settings for a specific version of a segment that's associated with an application.
This is a convenience which creates an instance of the
GetSegmentVersionRequest.Builderavoiding the need to create one manually viaGetSegmentVersionRequest.builder()- Parameters:
getSegmentVersionRequest- AConsumerthat will call methods onGetSegmentVersionRequest.Builderto create a request.- Returns:
- Result of the GetSegmentVersion operation returned by the service.
- See Also:
-
getSegmentVersions
default GetSegmentVersionsResponse getSegmentVersions(GetSegmentVersionsRequest getSegmentVersionsRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about the configuration, dimension, and other settings for all the versions of a specific segment that's associated with an application.
- Parameters:
getSegmentVersionsRequest-- Returns:
- Result of the GetSegmentVersions operation returned by the service.
- See Also:
-
getSegmentVersions
default GetSegmentVersionsResponse getSegmentVersions(Consumer<GetSegmentVersionsRequest.Builder> getSegmentVersionsRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about the configuration, dimension, and other settings for all the versions of a specific segment that's associated with an application.
This is a convenience which creates an instance of the
GetSegmentVersionsRequest.Builderavoiding the need to create one manually viaGetSegmentVersionsRequest.builder()- Parameters:
getSegmentVersionsRequest- AConsumerthat will call methods onGetSegmentVersionsRequest.Builderto create a request.- Returns:
- Result of the GetSegmentVersions operation returned by the service.
- See Also:
-
getSegments
default GetSegmentsResponse getSegments(GetSegmentsRequest getSegmentsRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException 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.
- See Also:
-
getSegments
default GetSegmentsResponse getSegments(Consumer<GetSegmentsRequest.Builder> getSegmentsRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about the configuration, dimension, and other settings for all the segments that are associated with an application.
This is a convenience which creates an instance of the
GetSegmentsRequest.Builderavoiding the need to create one manually viaGetSegmentsRequest.builder()- Parameters:
getSegmentsRequest- AConsumerthat will call methods onGetSegmentsRequest.Builderto create a request.- Returns:
- Result of the GetSegments operation returned by the service.
- See Also:
-
getSmsChannel
default GetSmsChannelResponse getSmsChannel(GetSmsChannelRequest getSmsChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException 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.
- See Also:
-
getSmsChannel
default GetSmsChannelResponse getSmsChannel(Consumer<GetSmsChannelRequest.Builder> getSmsChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about the status and settings of the SMS channel for an application.
This is a convenience which creates an instance of the
GetSmsChannelRequest.Builderavoiding the need to create one manually viaGetSmsChannelRequest.builder()- Parameters:
getSmsChannelRequest- AConsumerthat will call methods onGetSmsChannelRequest.Builderto create a request.- Returns:
- Result of the GetSmsChannel operation returned by the service.
- See Also:
-
getSmsTemplate
default GetSmsTemplateResponse getSmsTemplate(GetSmsTemplateRequest getSmsTemplateRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves the content and settings of a message template for messages that are sent through the SMS channel.
- Parameters:
getSmsTemplateRequest-- Returns:
- Result of the GetSmsTemplate operation returned by the service.
- See Also:
-
getSmsTemplate
default GetSmsTemplateResponse getSmsTemplate(Consumer<GetSmsTemplateRequest.Builder> getSmsTemplateRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves the content and settings of a message template for messages that are sent through the SMS channel.
This is a convenience which creates an instance of the
GetSmsTemplateRequest.Builderavoiding the need to create one manually viaGetSmsTemplateRequest.builder()- Parameters:
getSmsTemplateRequest- AConsumerthat will call methods onGetSmsTemplateRequest.Builderto create a request.- Returns:
- Result of the GetSmsTemplate operation returned by the service.
- See Also:
-
getUserEndpoints
default GetUserEndpointsResponse getUserEndpoints(GetUserEndpointsRequest getUserEndpointsRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException 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.
- See Also:
-
getUserEndpoints
default GetUserEndpointsResponse getUserEndpoints(Consumer<GetUserEndpointsRequest.Builder> getUserEndpointsRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about all the endpoints that are associated with a specific user ID.
This is a convenience which creates an instance of the
GetUserEndpointsRequest.Builderavoiding the need to create one manually viaGetUserEndpointsRequest.builder()- Parameters:
getUserEndpointsRequest- AConsumerthat will call methods onGetUserEndpointsRequest.Builderto create a request.- Returns:
- Result of the GetUserEndpoints operation returned by the service.
- See Also:
-
getVoiceChannel
default GetVoiceChannelResponse getVoiceChannel(GetVoiceChannelRequest getVoiceChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException 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.
- See Also:
-
getVoiceChannel
default GetVoiceChannelResponse getVoiceChannel(Consumer<GetVoiceChannelRequest.Builder> getVoiceChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about the status and settings of the voice channel for an application.
This is a convenience which creates an instance of the
GetVoiceChannelRequest.Builderavoiding the need to create one manually viaGetVoiceChannelRequest.builder()- Parameters:
getVoiceChannelRequest- AConsumerthat will call methods onGetVoiceChannelRequest.Builderto create a request.- Returns:
- Result of the GetVoiceChannel operation returned by the service.
- See Also:
-
getVoiceTemplate
default GetVoiceTemplateResponse getVoiceTemplate(GetVoiceTemplateRequest getVoiceTemplateRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves the content and settings of a message template for messages that are sent through the voice channel.
- Parameters:
getVoiceTemplateRequest-- Returns:
- Result of the GetVoiceTemplate operation returned by the service.
- See Also:
-
getVoiceTemplate
default GetVoiceTemplateResponse getVoiceTemplate(Consumer<GetVoiceTemplateRequest.Builder> getVoiceTemplateRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves the content and settings of a message template for messages that are sent through the voice channel.
This is a convenience which creates an instance of the
GetVoiceTemplateRequest.Builderavoiding the need to create one manually viaGetVoiceTemplateRequest.builder()- Parameters:
getVoiceTemplateRequest- AConsumerthat will call methods onGetVoiceTemplateRequest.Builderto create a request.- Returns:
- Result of the GetVoiceTemplate operation returned by the service.
- See Also:
-
listJourneys
default ListJourneysResponse listJourneys(ListJourneysRequest listJourneysRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about the status, configuration, and other settings for all the journeys that are associated with an application.
- Parameters:
listJourneysRequest-- Returns:
- Result of the ListJourneys operation returned by the service.
- See Also:
-
listJourneys
default ListJourneysResponse listJourneys(Consumer<ListJourneysRequest.Builder> listJourneysRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about the status, configuration, and other settings for all the journeys that are associated with an application.
This is a convenience which creates an instance of the
ListJourneysRequest.Builderavoiding the need to create one manually viaListJourneysRequest.builder()- Parameters:
listJourneysRequest- AConsumerthat will call methods onListJourneysRequest.Builderto create a request.- Returns:
- Result of the ListJourneys operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws AwsServiceException, SdkClientException, PinpointException Retrieves all the tags (keys and values) that are associated with an application, campaign, message template, or segment.
- Parameters:
listTagsForResourceRequest-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws AwsServiceException, SdkClientException, PinpointException Retrieves all the tags (keys and values) that are associated with an application, campaign, message template, or segment.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTemplateVersions
default ListTemplateVersionsResponse listTemplateVersions(ListTemplateVersionsRequest listTemplateVersionsRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about all the versions of a specific message template.
- Parameters:
listTemplateVersionsRequest-- Returns:
- Result of the ListTemplateVersions operation returned by the service.
- See Also:
-
listTemplateVersions
default ListTemplateVersionsResponse listTemplateVersions(Consumer<ListTemplateVersionsRequest.Builder> listTemplateVersionsRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about all the versions of a specific message template.
This is a convenience which creates an instance of the
ListTemplateVersionsRequest.Builderavoiding the need to create one manually viaListTemplateVersionsRequest.builder()- Parameters:
listTemplateVersionsRequest- AConsumerthat will call methods onListTemplateVersionsRequest.Builderto create a request.- Returns:
- Result of the ListTemplateVersions operation returned by the service.
- See Also:
-
listTemplates
default ListTemplatesResponse listTemplates(ListTemplatesRequest listTemplatesRequest) throws MethodNotAllowedException, TooManyRequestsException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, PinpointException Retrieves information about all the message templates that are associated with your Amazon Pinpoint account.
- Parameters:
listTemplatesRequest-- Returns:
- Result of the ListTemplates operation returned by the service.
- See Also:
-
listTemplates
default ListTemplatesResponse listTemplates(Consumer<ListTemplatesRequest.Builder> listTemplatesRequest) throws MethodNotAllowedException, TooManyRequestsException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, PinpointException Retrieves information about all the message templates that are associated with your Amazon Pinpoint account.
This is a convenience which creates an instance of the
ListTemplatesRequest.Builderavoiding the need to create one manually viaListTemplatesRequest.builder()- Parameters:
listTemplatesRequest- AConsumerthat will call methods onListTemplatesRequest.Builderto create a request.- Returns:
- Result of the ListTemplates operation returned by the service.
- See Also:
-
phoneNumberValidate
default PhoneNumberValidateResponse phoneNumberValidate(PhoneNumberValidateRequest phoneNumberValidateRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about a phone number.
- Parameters:
phoneNumberValidateRequest-- Returns:
- Result of the PhoneNumberValidate operation returned by the service.
- See Also:
-
phoneNumberValidate
default PhoneNumberValidateResponse phoneNumberValidate(Consumer<PhoneNumberValidateRequest.Builder> phoneNumberValidateRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Retrieves information about a phone number.
This is a convenience which creates an instance of the
PhoneNumberValidateRequest.Builderavoiding the need to create one manually viaPhoneNumberValidateRequest.builder()- Parameters:
phoneNumberValidateRequest- AConsumerthat will call methods onPhoneNumberValidateRequest.Builderto create a request.- Returns:
- Result of the PhoneNumberValidate operation returned by the service.
- See Also:
-
putEventStream
default PutEventStreamResponse putEventStream(PutEventStreamRequest putEventStreamRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException 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.
- See Also:
-
putEventStream
default PutEventStreamResponse putEventStream(Consumer<PutEventStreamRequest.Builder> putEventStreamRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Creates a new event stream for an application or updates the settings of an existing event stream for an application.
This is a convenience which creates an instance of the
PutEventStreamRequest.Builderavoiding the need to create one manually viaPutEventStreamRequest.builder()- Parameters:
putEventStreamRequest- AConsumerthat will call methods onPutEventStreamRequest.Builderto create a request.- Returns:
- Result of the PutEventStream operation returned by the service.
- See Also:
-
putEvents
default PutEventsResponse putEvents(PutEventsRequest putEventsRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException 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.
- See Also:
-
putEvents
default PutEventsResponse putEvents(Consumer<PutEventsRequest.Builder> putEventsRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Creates a new event to record for endpoints, or creates or updates endpoint data that existing events are associated with.
This is a convenience which creates an instance of the
PutEventsRequest.Builderavoiding the need to create one manually viaPutEventsRequest.builder()- Parameters:
putEventsRequest- AConsumerthat will call methods onPutEventsRequest.Builderto create a request.- Returns:
- Result of the PutEvents operation returned by the service.
- See Also:
-
removeAttributes
default RemoveAttributesResponse removeAttributes(RemoveAttributesRequest removeAttributesRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Removes one or more custom attributes, of the same attribute type, from the application. Existing endpoints still have the attributes but Amazon Pinpoint will stop capturing new or changed values for these attributes.
- Parameters:
removeAttributesRequest-- Returns:
- Result of the RemoveAttributes operation returned by the service.
- See Also:
-
removeAttributes
default RemoveAttributesResponse removeAttributes(Consumer<RemoveAttributesRequest.Builder> removeAttributesRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Removes one or more custom attributes, of the same attribute type, from the application. Existing endpoints still have the attributes but Amazon Pinpoint will stop capturing new or changed values for these attributes.
This is a convenience which creates an instance of the
RemoveAttributesRequest.Builderavoiding the need to create one manually viaRemoveAttributesRequest.builder()- Parameters:
removeAttributesRequest- AConsumerthat will call methods onRemoveAttributesRequest.Builderto create a request.- Returns:
- Result of the RemoveAttributes operation returned by the service.
- See Also:
-
sendMessages
default SendMessagesResponse sendMessages(SendMessagesRequest sendMessagesRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Creates and sends a direct message.
- Parameters:
sendMessagesRequest-- Returns:
- Result of the SendMessages operation returned by the service.
- See Also:
-
sendMessages
default SendMessagesResponse sendMessages(Consumer<SendMessagesRequest.Builder> sendMessagesRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Creates and sends a direct message.
This is a convenience which creates an instance of the
SendMessagesRequest.Builderavoiding the need to create one manually viaSendMessagesRequest.builder()- Parameters:
sendMessagesRequest- AConsumerthat will call methods onSendMessagesRequest.Builderto create a request.- Returns:
- Result of the SendMessages operation returned by the service.
- See Also:
-
sendOTPMessage
default SendOtpMessageResponse sendOTPMessage(SendOtpMessageRequest sendOtpMessageRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Send an OTP message
- Parameters:
sendOtpMessageRequest-- Returns:
- Result of the SendOTPMessage operation returned by the service.
- See Also:
-
sendOTPMessage
default SendOtpMessageResponse sendOTPMessage(Consumer<SendOtpMessageRequest.Builder> sendOtpMessageRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Send an OTP message
This is a convenience which creates an instance of the
SendOtpMessageRequest.Builderavoiding the need to create one manually viaSendOtpMessageRequest.builder()- Parameters:
sendOtpMessageRequest- AConsumerthat will call methods onSendOtpMessageRequest.Builderto create a request.- Returns:
- Result of the SendOTPMessage operation returned by the service.
- See Also:
-
sendUsersMessages
default SendUsersMessagesResponse sendUsersMessages(SendUsersMessagesRequest sendUsersMessagesRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Creates and sends a message to a list of users.
- Parameters:
sendUsersMessagesRequest-- Returns:
- Result of the SendUsersMessages operation returned by the service.
- See Also:
-
sendUsersMessages
default SendUsersMessagesResponse sendUsersMessages(Consumer<SendUsersMessagesRequest.Builder> sendUsersMessagesRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Creates and sends a message to a list of users.
This is a convenience which creates an instance of the
SendUsersMessagesRequest.Builderavoiding the need to create one manually viaSendUsersMessagesRequest.builder()- Parameters:
sendUsersMessagesRequest- AConsumerthat will call methods onSendUsersMessagesRequest.Builderto create a request.- Returns:
- Result of the SendUsersMessages operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws AwsServiceException, SdkClientException, PinpointException Adds one or more tags (keys and values) to an application, campaign, message template, or segment.
- Parameters:
tagResourceRequest-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws AwsServiceException, SdkClientException, PinpointException Adds one or more tags (keys and values) to an application, campaign, message template, or segment.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws AwsServiceException, SdkClientException, PinpointException Removes one or more tags (keys and values) from an application, campaign, message template, or segment.
- Parameters:
untagResourceRequest-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws AwsServiceException, SdkClientException, PinpointException Removes one or more tags (keys and values) from an application, campaign, message template, or segment.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateAdmChannel
default UpdateAdmChannelResponse updateAdmChannel(UpdateAdmChannelRequest updateAdmChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Enables the ADM channel for an application or updates the status and settings of the ADM channel for an application.
- Parameters:
updateAdmChannelRequest-- Returns:
- Result of the UpdateAdmChannel operation returned by the service.
- See Also:
-
updateAdmChannel
default UpdateAdmChannelResponse updateAdmChannel(Consumer<UpdateAdmChannelRequest.Builder> updateAdmChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Enables the ADM channel for an application or updates the status and settings of the ADM channel for an application.
This is a convenience which creates an instance of the
UpdateAdmChannelRequest.Builderavoiding the need to create one manually viaUpdateAdmChannelRequest.builder()- Parameters:
updateAdmChannelRequest- AConsumerthat will call methods onUpdateAdmChannelRequest.Builderto create a request.- Returns:
- Result of the UpdateAdmChannel operation returned by the service.
- See Also:
-
updateApnsChannel
default UpdateApnsChannelResponse updateApnsChannel(UpdateApnsChannelRequest updateApnsChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Enables the APNs channel for an application or updates the status and settings of the APNs channel for an application.
- Parameters:
updateApnsChannelRequest-- Returns:
- Result of the UpdateApnsChannel operation returned by the service.
- See Also:
-
updateApnsChannel
default UpdateApnsChannelResponse updateApnsChannel(Consumer<UpdateApnsChannelRequest.Builder> updateApnsChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Enables the APNs channel for an application or updates the status and settings of the APNs channel for an application.
This is a convenience which creates an instance of the
UpdateApnsChannelRequest.Builderavoiding the need to create one manually viaUpdateApnsChannelRequest.builder()- Parameters:
updateApnsChannelRequest- AConsumerthat will call methods onUpdateApnsChannelRequest.Builderto create a request.- Returns:
- Result of the UpdateApnsChannel operation returned by the service.
- See Also:
-
updateApnsSandboxChannel
default UpdateApnsSandboxChannelResponse updateApnsSandboxChannel(UpdateApnsSandboxChannelRequest updateApnsSandboxChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Enables the APNs sandbox channel for an application or updates the status and settings of the APNs sandbox channel for an application.
- Parameters:
updateApnsSandboxChannelRequest-- Returns:
- Result of the UpdateApnsSandboxChannel operation returned by the service.
- See Also:
-
updateApnsSandboxChannel
default UpdateApnsSandboxChannelResponse updateApnsSandboxChannel(Consumer<UpdateApnsSandboxChannelRequest.Builder> updateApnsSandboxChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Enables the APNs sandbox channel for an application or updates the status and settings of the APNs sandbox channel for an application.
This is a convenience which creates an instance of the
UpdateApnsSandboxChannelRequest.Builderavoiding the need to create one manually viaUpdateApnsSandboxChannelRequest.builder()- Parameters:
updateApnsSandboxChannelRequest- AConsumerthat will call methods onUpdateApnsSandboxChannelRequest.Builderto create a request.- Returns:
- Result of the UpdateApnsSandboxChannel operation returned by the service.
- See Also:
-
updateApnsVoipChannel
default UpdateApnsVoipChannelResponse updateApnsVoipChannel(UpdateApnsVoipChannelRequest updateApnsVoipChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Enables the APNs VoIP channel for an application or updates the status and settings of the APNs VoIP channel for an application.
- Parameters:
updateApnsVoipChannelRequest-- Returns:
- Result of the UpdateApnsVoipChannel operation returned by the service.
- See Also:
-
updateApnsVoipChannel
default UpdateApnsVoipChannelResponse updateApnsVoipChannel(Consumer<UpdateApnsVoipChannelRequest.Builder> updateApnsVoipChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Enables the APNs VoIP channel for an application or updates the status and settings of the APNs VoIP channel for an application.
This is a convenience which creates an instance of the
UpdateApnsVoipChannelRequest.Builderavoiding the need to create one manually viaUpdateApnsVoipChannelRequest.builder()- Parameters:
updateApnsVoipChannelRequest- AConsumerthat will call methods onUpdateApnsVoipChannelRequest.Builderto create a request.- Returns:
- Result of the UpdateApnsVoipChannel operation returned by the service.
- See Also:
-
updateApnsVoipSandboxChannel
default UpdateApnsVoipSandboxChannelResponse updateApnsVoipSandboxChannel(UpdateApnsVoipSandboxChannelRequest updateApnsVoipSandboxChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Enables the APNs VoIP sandbox channel for an application or updates the status and settings of the APNs VoIP sandbox channel for an application.
- Parameters:
updateApnsVoipSandboxChannelRequest-- Returns:
- Result of the UpdateApnsVoipSandboxChannel operation returned by the service.
- See Also:
-
updateApnsVoipSandboxChannel
default UpdateApnsVoipSandboxChannelResponse updateApnsVoipSandboxChannel(Consumer<UpdateApnsVoipSandboxChannelRequest.Builder> updateApnsVoipSandboxChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Enables the APNs VoIP sandbox channel for an application or updates the status and settings of the APNs VoIP sandbox channel for an application.
This is a convenience which creates an instance of the
UpdateApnsVoipSandboxChannelRequest.Builderavoiding the need to create one manually viaUpdateApnsVoipSandboxChannelRequest.builder()- Parameters:
updateApnsVoipSandboxChannelRequest- AConsumerthat will call methods onUpdateApnsVoipSandboxChannelRequest.Builderto create a request.- Returns:
- Result of the UpdateApnsVoipSandboxChannel operation returned by the service.
- See Also:
-
updateApplicationSettings
default UpdateApplicationSettingsResponse updateApplicationSettings(UpdateApplicationSettingsRequest updateApplicationSettingsRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Updates the settings for an application.
- Parameters:
updateApplicationSettingsRequest-- Returns:
- Result of the UpdateApplicationSettings operation returned by the service.
- See Also:
-
updateApplicationSettings
default UpdateApplicationSettingsResponse updateApplicationSettings(Consumer<UpdateApplicationSettingsRequest.Builder> updateApplicationSettingsRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Updates the settings for an application.
This is a convenience which creates an instance of the
UpdateApplicationSettingsRequest.Builderavoiding the need to create one manually viaUpdateApplicationSettingsRequest.builder()- Parameters:
updateApplicationSettingsRequest- AConsumerthat will call methods onUpdateApplicationSettingsRequest.Builderto create a request.- Returns:
- Result of the UpdateApplicationSettings operation returned by the service.
- See Also:
-
updateBaiduChannel
default UpdateBaiduChannelResponse updateBaiduChannel(UpdateBaiduChannelRequest updateBaiduChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Enables the Baidu channel for an application or updates the status and settings of the Baidu channel for an application.
- Parameters:
updateBaiduChannelRequest-- Returns:
- Result of the UpdateBaiduChannel operation returned by the service.
- See Also:
-
updateBaiduChannel
default UpdateBaiduChannelResponse updateBaiduChannel(Consumer<UpdateBaiduChannelRequest.Builder> updateBaiduChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Enables the Baidu channel for an application or updates the status and settings of the Baidu channel for an application.
This is a convenience which creates an instance of the
UpdateBaiduChannelRequest.Builderavoiding the need to create one manually viaUpdateBaiduChannelRequest.builder()- Parameters:
updateBaiduChannelRequest- AConsumerthat will call methods onUpdateBaiduChannelRequest.Builderto create a request.- Returns:
- Result of the UpdateBaiduChannel operation returned by the service.
- See Also:
-
updateCampaign
default UpdateCampaignResponse updateCampaign(UpdateCampaignRequest updateCampaignRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Updates the configuration and other settings for a campaign.
- Parameters:
updateCampaignRequest-- Returns:
- Result of the UpdateCampaign operation returned by the service.
- See Also:
-
updateCampaign
default UpdateCampaignResponse updateCampaign(Consumer<UpdateCampaignRequest.Builder> updateCampaignRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Updates the configuration and other settings for a campaign.
This is a convenience which creates an instance of the
UpdateCampaignRequest.Builderavoiding the need to create one manually viaUpdateCampaignRequest.builder()- Parameters:
updateCampaignRequest- AConsumerthat will call methods onUpdateCampaignRequest.Builderto create a request.- Returns:
- Result of the UpdateCampaign operation returned by the service.
- See Also:
-
updateEmailChannel
default UpdateEmailChannelResponse updateEmailChannel(UpdateEmailChannelRequest updateEmailChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Enables the email channel for an application or updates the status and settings of the email channel for an application.
- Parameters:
updateEmailChannelRequest-- Returns:
- Result of the UpdateEmailChannel operation returned by the service.
- See Also:
-
updateEmailChannel
default UpdateEmailChannelResponse updateEmailChannel(Consumer<UpdateEmailChannelRequest.Builder> updateEmailChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Enables the email channel for an application or updates the status and settings of the email channel for an application.
This is a convenience which creates an instance of the
UpdateEmailChannelRequest.Builderavoiding the need to create one manually viaUpdateEmailChannelRequest.builder()- Parameters:
updateEmailChannelRequest- AConsumerthat will call methods onUpdateEmailChannelRequest.Builderto create a request.- Returns:
- Result of the UpdateEmailChannel operation returned by the service.
- See Also:
-
updateEmailTemplate
default UpdateEmailTemplateResponse updateEmailTemplate(UpdateEmailTemplateRequest updateEmailTemplateRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Updates an existing message template for messages that are sent through the email channel.
- Parameters:
updateEmailTemplateRequest-- Returns:
- Result of the UpdateEmailTemplate operation returned by the service.
- See Also:
-
updateEmailTemplate
default UpdateEmailTemplateResponse updateEmailTemplate(Consumer<UpdateEmailTemplateRequest.Builder> updateEmailTemplateRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Updates an existing message template for messages that are sent through the email channel.
This is a convenience which creates an instance of the
UpdateEmailTemplateRequest.Builderavoiding the need to create one manually viaUpdateEmailTemplateRequest.builder()- Parameters:
updateEmailTemplateRequest- AConsumerthat will call methods onUpdateEmailTemplateRequest.Builderto create a request.- Returns:
- Result of the UpdateEmailTemplate operation returned by the service.
- See Also:
-
updateEndpoint
default UpdateEndpointResponse updateEndpoint(UpdateEndpointRequest updateEndpointRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Creates a new endpoint for an application or updates the settings and attributes of an existing endpoint for an application. You can also use this operation to define custom attributes for an endpoint. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values.
- Parameters:
updateEndpointRequest-- Returns:
- Result of the UpdateEndpoint operation returned by the service.
- See Also:
-
updateEndpoint
default UpdateEndpointResponse updateEndpoint(Consumer<UpdateEndpointRequest.Builder> updateEndpointRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Creates a new endpoint for an application or updates the settings and attributes of an existing endpoint for an application. You can also use this operation to define custom attributes for an endpoint. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values.
This is a convenience which creates an instance of the
UpdateEndpointRequest.Builderavoiding the need to create one manually viaUpdateEndpointRequest.builder()- Parameters:
updateEndpointRequest- AConsumerthat will call methods onUpdateEndpointRequest.Builderto create a request.- Returns:
- Result of the UpdateEndpoint operation returned by the service.
- See Also:
-
updateEndpointsBatch
default UpdateEndpointsBatchResponse updateEndpointsBatch(UpdateEndpointsBatchRequest updateEndpointsBatchRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Creates a new batch of endpoints for an application or updates the settings and attributes of a batch of existing endpoints for an application. You can also use this operation to define custom attributes for a batch of endpoints. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values.
- Parameters:
updateEndpointsBatchRequest-- Returns:
- Result of the UpdateEndpointsBatch operation returned by the service.
- See Also:
-
updateEndpointsBatch
default UpdateEndpointsBatchResponse updateEndpointsBatch(Consumer<UpdateEndpointsBatchRequest.Builder> updateEndpointsBatchRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Creates a new batch of endpoints for an application or updates the settings and attributes of a batch of existing endpoints for an application. You can also use this operation to define custom attributes for a batch of endpoints. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values.
This is a convenience which creates an instance of the
UpdateEndpointsBatchRequest.Builderavoiding the need to create one manually viaUpdateEndpointsBatchRequest.builder()- Parameters:
updateEndpointsBatchRequest- AConsumerthat will call methods onUpdateEndpointsBatchRequest.Builderto create a request.- Returns:
- Result of the UpdateEndpointsBatch operation returned by the service.
- See Also:
-
updateGcmChannel
default UpdateGcmChannelResponse updateGcmChannel(UpdateGcmChannelRequest updateGcmChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Enables the GCM channel for an application or updates the status and settings of the GCM channel for an application.
- Parameters:
updateGcmChannelRequest-- Returns:
- Result of the UpdateGcmChannel operation returned by the service.
- See Also:
-
updateGcmChannel
default UpdateGcmChannelResponse updateGcmChannel(Consumer<UpdateGcmChannelRequest.Builder> updateGcmChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Enables the GCM channel for an application or updates the status and settings of the GCM channel for an application.
This is a convenience which creates an instance of the
UpdateGcmChannelRequest.Builderavoiding the need to create one manually viaUpdateGcmChannelRequest.builder()- Parameters:
updateGcmChannelRequest- AConsumerthat will call methods onUpdateGcmChannelRequest.Builderto create a request.- Returns:
- Result of the UpdateGcmChannel operation returned by the service.
- See Also:
-
updateInAppTemplate
default UpdateInAppTemplateResponse updateInAppTemplate(UpdateInAppTemplateRequest updateInAppTemplateRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Updates an existing message template for messages sent through the in-app message channel.
- Parameters:
updateInAppTemplateRequest-- Returns:
- Result of the UpdateInAppTemplate operation returned by the service.
- See Also:
-
updateInAppTemplate
default UpdateInAppTemplateResponse updateInAppTemplate(Consumer<UpdateInAppTemplateRequest.Builder> updateInAppTemplateRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Updates an existing message template for messages sent through the in-app message channel.
This is a convenience which creates an instance of the
UpdateInAppTemplateRequest.Builderavoiding the need to create one manually viaUpdateInAppTemplateRequest.builder()- Parameters:
updateInAppTemplateRequest- AConsumerthat will call methods onUpdateInAppTemplateRequest.Builderto create a request.- Returns:
- Result of the UpdateInAppTemplate operation returned by the service.
- See Also:
-
updateJourney
default UpdateJourneyResponse updateJourney(UpdateJourneyRequest updateJourneyRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, ConflictException, AwsServiceException, SdkClientException, PinpointException Updates the configuration and other settings for a journey.
- Parameters:
updateJourneyRequest-- Returns:
- Result of the UpdateJourney operation returned by the service.
- See Also:
-
updateJourney
default UpdateJourneyResponse updateJourney(Consumer<UpdateJourneyRequest.Builder> updateJourneyRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, ConflictException, AwsServiceException, SdkClientException, PinpointException Updates the configuration and other settings for a journey.
This is a convenience which creates an instance of the
UpdateJourneyRequest.Builderavoiding the need to create one manually viaUpdateJourneyRequest.builder()- Parameters:
updateJourneyRequest- AConsumerthat will call methods onUpdateJourneyRequest.Builderto create a request.- Returns:
- Result of the UpdateJourney operation returned by the service.
- See Also:
-
updateJourneyState
default UpdateJourneyStateResponse updateJourneyState(UpdateJourneyStateRequest updateJourneyStateRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Cancels (stops) an active journey.
- Parameters:
updateJourneyStateRequest-- Returns:
- Result of the UpdateJourneyState operation returned by the service.
- See Also:
-
updateJourneyState
default UpdateJourneyStateResponse updateJourneyState(Consumer<UpdateJourneyStateRequest.Builder> updateJourneyStateRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Cancels (stops) an active journey.
This is a convenience which creates an instance of the
UpdateJourneyStateRequest.Builderavoiding the need to create one manually viaUpdateJourneyStateRequest.builder()- Parameters:
updateJourneyStateRequest- AConsumerthat will call methods onUpdateJourneyStateRequest.Builderto create a request.- Returns:
- Result of the UpdateJourneyState operation returned by the service.
- See Also:
-
updatePushTemplate
default UpdatePushTemplateResponse updatePushTemplate(UpdatePushTemplateRequest updatePushTemplateRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Updates an existing message template for messages that are sent through a push notification channel.
- Parameters:
updatePushTemplateRequest-- Returns:
- Result of the UpdatePushTemplate operation returned by the service.
- See Also:
-
updatePushTemplate
default UpdatePushTemplateResponse updatePushTemplate(Consumer<UpdatePushTemplateRequest.Builder> updatePushTemplateRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Updates an existing message template for messages that are sent through a push notification channel.
This is a convenience which creates an instance of the
UpdatePushTemplateRequest.Builderavoiding the need to create one manually viaUpdatePushTemplateRequest.builder()- Parameters:
updatePushTemplateRequest- AConsumerthat will call methods onUpdatePushTemplateRequest.Builderto create a request.- Returns:
- Result of the UpdatePushTemplate operation returned by the service.
- See Also:
-
updateRecommenderConfiguration
default UpdateRecommenderConfigurationResponse updateRecommenderConfiguration(UpdateRecommenderConfigurationRequest updateRecommenderConfigurationRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Updates an Amazon Pinpoint configuration for a recommender model.
- Parameters:
updateRecommenderConfigurationRequest-- Returns:
- Result of the UpdateRecommenderConfiguration operation returned by the service.
- See Also:
-
updateRecommenderConfiguration
default UpdateRecommenderConfigurationResponse updateRecommenderConfiguration(Consumer<UpdateRecommenderConfigurationRequest.Builder> updateRecommenderConfigurationRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Updates an Amazon Pinpoint configuration for a recommender model.
This is a convenience which creates an instance of the
UpdateRecommenderConfigurationRequest.Builderavoiding the need to create one manually viaUpdateRecommenderConfigurationRequest.builder()- Parameters:
updateRecommenderConfigurationRequest- AConsumerthat will call methods onUpdateRecommenderConfigurationRequest.Builderto create a request.- Returns:
- Result of the UpdateRecommenderConfiguration operation returned by the service.
- See Also:
-
updateSegment
default UpdateSegmentResponse updateSegment(UpdateSegmentRequest updateSegmentRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException 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.
- See Also:
-
updateSegment
default UpdateSegmentResponse updateSegment(Consumer<UpdateSegmentRequest.Builder> updateSegmentRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException 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.
This is a convenience which creates an instance of the
UpdateSegmentRequest.Builderavoiding the need to create one manually viaUpdateSegmentRequest.builder()- Parameters:
updateSegmentRequest- AConsumerthat will call methods onUpdateSegmentRequest.Builderto create a request.- Returns:
- Result of the UpdateSegment operation returned by the service.
- See Also:
-
updateSmsChannel
default UpdateSmsChannelResponse updateSmsChannel(UpdateSmsChannelRequest updateSmsChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Enables the SMS channel for an application or updates the status and settings of the SMS channel for an application.
- Parameters:
updateSmsChannelRequest-- Returns:
- Result of the UpdateSmsChannel operation returned by the service.
- See Also:
-
updateSmsChannel
default UpdateSmsChannelResponse updateSmsChannel(Consumer<UpdateSmsChannelRequest.Builder> updateSmsChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Enables the SMS channel for an application or updates the status and settings of the SMS channel for an application.
This is a convenience which creates an instance of the
UpdateSmsChannelRequest.Builderavoiding the need to create one manually viaUpdateSmsChannelRequest.builder()- Parameters:
updateSmsChannelRequest- AConsumerthat will call methods onUpdateSmsChannelRequest.Builderto create a request.- Returns:
- Result of the UpdateSmsChannel operation returned by the service.
- See Also:
-
updateSmsTemplate
default UpdateSmsTemplateResponse updateSmsTemplate(UpdateSmsTemplateRequest updateSmsTemplateRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Updates an existing message template for messages that are sent through the SMS channel.
- Parameters:
updateSmsTemplateRequest-- Returns:
- Result of the UpdateSmsTemplate operation returned by the service.
- See Also:
-
updateSmsTemplate
default UpdateSmsTemplateResponse updateSmsTemplate(Consumer<UpdateSmsTemplateRequest.Builder> updateSmsTemplateRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Updates an existing message template for messages that are sent through the SMS channel.
This is a convenience which creates an instance of the
UpdateSmsTemplateRequest.Builderavoiding the need to create one manually viaUpdateSmsTemplateRequest.builder()- Parameters:
updateSmsTemplateRequest- AConsumerthat will call methods onUpdateSmsTemplateRequest.Builderto create a request.- Returns:
- Result of the UpdateSmsTemplate operation returned by the service.
- See Also:
-
updateTemplateActiveVersion
default UpdateTemplateActiveVersionResponse updateTemplateActiveVersion(UpdateTemplateActiveVersionRequest updateTemplateActiveVersionRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Changes the status of a specific version of a message template to active.
- Parameters:
updateTemplateActiveVersionRequest-- Returns:
- Result of the UpdateTemplateActiveVersion operation returned by the service.
- See Also:
-
updateTemplateActiveVersion
default UpdateTemplateActiveVersionResponse updateTemplateActiveVersion(Consumer<UpdateTemplateActiveVersionRequest.Builder> updateTemplateActiveVersionRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Changes the status of a specific version of a message template to active.
This is a convenience which creates an instance of the
UpdateTemplateActiveVersionRequest.Builderavoiding the need to create one manually viaUpdateTemplateActiveVersionRequest.builder()- Parameters:
updateTemplateActiveVersionRequest- AConsumerthat will call methods onUpdateTemplateActiveVersionRequest.Builderto create a request.- Returns:
- Result of the UpdateTemplateActiveVersion operation returned by the service.
- See Also:
-
updateVoiceChannel
default UpdateVoiceChannelResponse updateVoiceChannel(UpdateVoiceChannelRequest updateVoiceChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Enables the voice channel for an application or updates the status and settings of the voice channel for an application.
- Parameters:
updateVoiceChannelRequest-- Returns:
- Result of the UpdateVoiceChannel operation returned by the service.
- See Also:
-
updateVoiceChannel
default UpdateVoiceChannelResponse updateVoiceChannel(Consumer<UpdateVoiceChannelRequest.Builder> updateVoiceChannelRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Enables the voice channel for an application or updates the status and settings of the voice channel for an application.
This is a convenience which creates an instance of the
UpdateVoiceChannelRequest.Builderavoiding the need to create one manually viaUpdateVoiceChannelRequest.builder()- Parameters:
updateVoiceChannelRequest- AConsumerthat will call methods onUpdateVoiceChannelRequest.Builderto create a request.- Returns:
- Result of the UpdateVoiceChannel operation returned by the service.
- See Also:
-
updateVoiceTemplate
default UpdateVoiceTemplateResponse updateVoiceTemplate(UpdateVoiceTemplateRequest updateVoiceTemplateRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Updates an existing message template for messages that are sent through the voice channel.
- Parameters:
updateVoiceTemplateRequest-- Returns:
- Result of the UpdateVoiceTemplate operation returned by the service.
- See Also:
-
updateVoiceTemplate
default UpdateVoiceTemplateResponse updateVoiceTemplate(Consumer<UpdateVoiceTemplateRequest.Builder> updateVoiceTemplateRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Updates an existing message template for messages that are sent through the voice channel.
This is a convenience which creates an instance of the
UpdateVoiceTemplateRequest.Builderavoiding the need to create one manually viaUpdateVoiceTemplateRequest.builder()- Parameters:
updateVoiceTemplateRequest- AConsumerthat will call methods onUpdateVoiceTemplateRequest.Builderto create a request.- Returns:
- Result of the UpdateVoiceTemplate operation returned by the service.
- See Also:
-
verifyOTPMessage
default VerifyOtpMessageResponse verifyOTPMessage(VerifyOtpMessageRequest verifyOtpMessageRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Verify an OTP
- Parameters:
verifyOtpMessageRequest-- Returns:
- Result of the VerifyOTPMessage operation returned by the service.
- See Also:
-
verifyOTPMessage
default VerifyOtpMessageResponse verifyOTPMessage(Consumer<VerifyOtpMessageRequest.Builder> verifyOtpMessageRequest) throws BadRequestException, InternalServerErrorException, PayloadTooLargeException, ForbiddenException, NotFoundException, MethodNotAllowedException, TooManyRequestsException, AwsServiceException, SdkClientException, PinpointException Verify an OTP
This is a convenience which creates an instance of the
VerifyOtpMessageRequest.Builderavoiding the need to create one manually viaVerifyOtpMessageRequest.builder()- Parameters:
verifyOtpMessageRequest- AConsumerthat will call methods onVerifyOtpMessageRequest.Builderto create a request.- Returns:
- Result of the VerifyOTPMessage operation returned by the service.
- See Also:
-
create
Create aPinpointClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aPinpointClient. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-