pinpoint/aws.sdk.kotlin.services.pinpoint/PinpointClient

PinpointClient

interface PinpointClient : SdkClient

Doc Engage API - Amazon Pinpoint API

Properties

Link copied to clipboard
abstract override val config: PinpointClient.Config

PinpointClient's configuration

Functions

Link copied to clipboard
abstract suspend fun createApp(input: CreateAppRequest): CreateAppResponse

Creates an application.

Link copied to clipboard
abstract suspend fun createCampaign(input: CreateCampaignRequest): CreateCampaignResponse

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

Link copied to clipboard
abstract suspend fun createEmailTemplate(input: CreateEmailTemplateRequest): CreateEmailTemplateResponse

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

Link copied to clipboard
abstract suspend fun createExportJob(input: CreateExportJobRequest): CreateExportJobResponse

Creates an export job for an application.

Link copied to clipboard
abstract suspend fun createImportJob(input: CreateImportJobRequest): CreateImportJobResponse

Creates an import job for an application.

Link copied to clipboard
abstract suspend fun createInAppTemplate(input: CreateInAppTemplateRequest): CreateInAppTemplateResponse

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

Link copied to clipboard
abstract suspend fun createJourney(input: CreateJourneyRequest): CreateJourneyResponse

Creates a journey for an application.

Link copied to clipboard
abstract suspend fun createPushTemplate(input: CreatePushTemplateRequest): CreatePushTemplateResponse

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

Link copied to clipboard
abstract suspend fun createRecommenderConfiguration(input: CreateRecommenderConfigurationRequest): CreateRecommenderConfigurationResponse

Creates an Amazon Pinpoint configuration for a recommender model.

Link copied to clipboard
abstract suspend fun createSegment(input: CreateSegmentRequest): CreateSegmentResponse

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.

Link copied to clipboard
abstract suspend fun createSmsTemplate(input: CreateSmsTemplateRequest): CreateSmsTemplateResponse

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

Link copied to clipboard
abstract suspend fun createVoiceTemplate(input: CreateVoiceTemplateRequest): CreateVoiceTemplateResponse

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

Link copied to clipboard
abstract suspend fun deleteAdmChannel(input: DeleteAdmChannelRequest): DeleteAdmChannelResponse

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

Link copied to clipboard
abstract suspend fun deleteApnsChannel(input: DeleteApnsChannelRequest): DeleteApnsChannelResponse

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

Link copied to clipboard
abstract suspend fun deleteApnsSandboxChannel(input: DeleteApnsSandboxChannelRequest): DeleteApnsSandboxChannelResponse

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

Link copied to clipboard
abstract suspend fun deleteApnsVoipChannel(input: DeleteApnsVoipChannelRequest): DeleteApnsVoipChannelResponse

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

Link copied to clipboard
abstract suspend fun deleteApnsVoipSandboxChannel(input: DeleteApnsVoipSandboxChannelRequest): DeleteApnsVoipSandboxChannelResponse

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

Link copied to clipboard
abstract suspend fun deleteApp(input: DeleteAppRequest): DeleteAppResponse

Deletes an application.

Link copied to clipboard
abstract suspend fun deleteBaiduChannel(input: DeleteBaiduChannelRequest): DeleteBaiduChannelResponse

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

Link copied to clipboard
abstract suspend fun deleteCampaign(input: DeleteCampaignRequest): DeleteCampaignResponse

Deletes a campaign from an application.

Link copied to clipboard
abstract suspend fun deleteEmailChannel(input: DeleteEmailChannelRequest): DeleteEmailChannelResponse

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

Link copied to clipboard
abstract suspend fun deleteEmailTemplate(input: DeleteEmailTemplateRequest): DeleteEmailTemplateResponse

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

Link copied to clipboard
abstract suspend fun deleteEndpoint(input: DeleteEndpointRequest): DeleteEndpointResponse

Deletes an endpoint from an application.

Link copied to clipboard
abstract suspend fun deleteEventStream(input: DeleteEventStreamRequest): DeleteEventStreamResponse

Deletes the event stream for an application.

Link copied to clipboard
abstract suspend fun deleteGcmChannel(input: DeleteGcmChannelRequest): DeleteGcmChannelResponse

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

Link copied to clipboard
abstract suspend fun deleteInAppTemplate(input: DeleteInAppTemplateRequest): DeleteInAppTemplateResponse

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

Link copied to clipboard
abstract suspend fun deleteJourney(input: DeleteJourneyRequest): DeleteJourneyResponse

Deletes a journey from an application.

Link copied to clipboard
abstract suspend fun deletePushTemplate(input: DeletePushTemplateRequest): DeletePushTemplateResponse

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

Link copied to clipboard
abstract suspend fun deleteRecommenderConfiguration(input: DeleteRecommenderConfigurationRequest): DeleteRecommenderConfigurationResponse

Deletes an Amazon Pinpoint configuration for a recommender model.

Link copied to clipboard
abstract suspend fun deleteSegment(input: DeleteSegmentRequest): DeleteSegmentResponse

Deletes a segment from an application.

Link copied to clipboard
abstract suspend fun deleteSmsChannel(input: DeleteSmsChannelRequest): DeleteSmsChannelResponse

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

Link copied to clipboard
abstract suspend fun deleteSmsTemplate(input: DeleteSmsTemplateRequest): DeleteSmsTemplateResponse

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

Link copied to clipboard
abstract suspend fun deleteUserEndpoints(input: DeleteUserEndpointsRequest): DeleteUserEndpointsResponse

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

Link copied to clipboard
abstract suspend fun deleteVoiceChannel(input: DeleteVoiceChannelRequest): DeleteVoiceChannelResponse

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

Link copied to clipboard
abstract suspend fun deleteVoiceTemplate(input: DeleteVoiceTemplateRequest): DeleteVoiceTemplateResponse

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

Link copied to clipboard
abstract suspend fun getAdmChannel(input: GetAdmChannelRequest): GetAdmChannelResponse

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

Link copied to clipboard
abstract suspend fun getApnsChannel(input: GetApnsChannelRequest): GetApnsChannelResponse

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

Link copied to clipboard
abstract suspend fun getApnsSandboxChannel(input: GetApnsSandboxChannelRequest): GetApnsSandboxChannelResponse

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

Link copied to clipboard
abstract suspend fun getApnsVoipChannel(input: GetApnsVoipChannelRequest): GetApnsVoipChannelResponse

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

Link copied to clipboard
abstract suspend fun getApnsVoipSandboxChannel(input: GetApnsVoipSandboxChannelRequest): GetApnsVoipSandboxChannelResponse

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

Link copied to clipboard
abstract suspend fun getApp(input: GetAppRequest): GetAppResponse

Retrieves information about an application.

Link copied to clipboard
abstract suspend fun getApplicationDateRangeKpi(input: GetApplicationDateRangeKpiRequest): GetApplicationDateRangeKpiResponse

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

Link copied to clipboard
abstract suspend fun getApplicationSettings(input: GetApplicationSettingsRequest): GetApplicationSettingsResponse

Retrieves information about the settings for an application.

Link copied to clipboard
abstract suspend fun getApps(input: GetAppsRequest = GetAppsRequest { }): GetAppsResponse

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

Link copied to clipboard
abstract suspend fun getBaiduChannel(input: GetBaiduChannelRequest): GetBaiduChannelResponse

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

Link copied to clipboard
abstract suspend fun getCampaign(input: GetCampaignRequest): GetCampaignResponse

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

Link copied to clipboard
abstract suspend fun getCampaignActivities(input: GetCampaignActivitiesRequest): GetCampaignActivitiesResponse

Retrieves information about all the activities for a campaign.

Link copied to clipboard
abstract suspend fun getCampaignDateRangeKpi(input: GetCampaignDateRangeKpiRequest): GetCampaignDateRangeKpiResponse

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

Link copied to clipboard
abstract suspend fun getCampaigns(input: GetCampaignsRequest): GetCampaignsResponse

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

Link copied to clipboard
abstract suspend fun getCampaignVersion(input: GetCampaignVersionRequest): GetCampaignVersionResponse

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

Link copied to clipboard
abstract suspend fun getCampaignVersions(input: GetCampaignVersionsRequest): GetCampaignVersionsResponse

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

Link copied to clipboard
abstract suspend fun getChannels(input: GetChannelsRequest): GetChannelsResponse

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

Link copied to clipboard
abstract suspend fun getEmailChannel(input: GetEmailChannelRequest): GetEmailChannelResponse

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

Link copied to clipboard
abstract suspend fun getEmailTemplate(input: GetEmailTemplateRequest): GetEmailTemplateResponse

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

Link copied to clipboard
abstract suspend fun getEndpoint(input: GetEndpointRequest): GetEndpointResponse

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

Link copied to clipboard
abstract suspend fun getEventStream(input: GetEventStreamRequest): GetEventStreamResponse

Retrieves information about the event stream settings for an application.

Link copied to clipboard
abstract suspend fun getExportJob(input: GetExportJobRequest): GetExportJobResponse

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

Link copied to clipboard
abstract suspend fun getExportJobs(input: GetExportJobsRequest): GetExportJobsResponse

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

Link copied to clipboard
abstract suspend fun getGcmChannel(input: GetGcmChannelRequest): GetGcmChannelResponse

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

Link copied to clipboard
abstract suspend fun getImportJob(input: GetImportJobRequest): GetImportJobResponse

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

Link copied to clipboard
abstract suspend fun getImportJobs(input: GetImportJobsRequest): GetImportJobsResponse

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

Link copied to clipboard
abstract suspend fun getInAppMessages(input: GetInAppMessagesRequest): GetInAppMessagesResponse

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

Link copied to clipboard
abstract suspend fun getInAppTemplate(input: GetInAppTemplateRequest): GetInAppTemplateResponse

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

Link copied to clipboard
abstract suspend fun getJourney(input: GetJourneyRequest): GetJourneyResponse

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

Link copied to clipboard
abstract suspend fun getJourneyDateRangeKpi(input: GetJourneyDateRangeKpiRequest): GetJourneyDateRangeKpiResponse

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

Link copied to clipboard
abstract suspend fun getJourneyExecutionActivityMetrics(input: GetJourneyExecutionActivityMetricsRequest): GetJourneyExecutionActivityMetricsResponse

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

Link copied to clipboard
abstract suspend fun getJourneyExecutionMetrics(input: GetJourneyExecutionMetricsRequest): GetJourneyExecutionMetricsResponse

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

Link copied to clipboard
abstract suspend fun getJourneyRunExecutionActivityMetrics(input: GetJourneyRunExecutionActivityMetricsRequest): GetJourneyRunExecutionActivityMetricsResponse

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

Link copied to clipboard
abstract suspend fun getJourneyRunExecutionMetrics(input: GetJourneyRunExecutionMetricsRequest): GetJourneyRunExecutionMetricsResponse

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

Link copied to clipboard
abstract suspend fun getJourneyRuns(input: GetJourneyRunsRequest): GetJourneyRunsResponse

Provides information about the runs of a journey.

Link copied to clipboard
abstract suspend fun getPushTemplate(input: GetPushTemplateRequest): GetPushTemplateResponse

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

Link copied to clipboard
abstract suspend fun getRecommenderConfiguration(input: GetRecommenderConfigurationRequest): GetRecommenderConfigurationResponse

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

Link copied to clipboard
abstract suspend fun getRecommenderConfigurations(input: GetRecommenderConfigurationsRequest = GetRecommenderConfigurationsRequest { }): GetRecommenderConfigurationsResponse

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

Link copied to clipboard
abstract suspend fun getSegment(input: GetSegmentRequest): GetSegmentResponse

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

Link copied to clipboard
abstract suspend fun getSegmentExportJobs(input: GetSegmentExportJobsRequest): GetSegmentExportJobsResponse

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

Link copied to clipboard
abstract suspend fun getSegmentImportJobs(input: GetSegmentImportJobsRequest): GetSegmentImportJobsResponse

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

Link copied to clipboard
abstract suspend fun getSegments(input: GetSegmentsRequest): GetSegmentsResponse

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

Link copied to clipboard
abstract suspend fun getSegmentVersion(input: GetSegmentVersionRequest): GetSegmentVersionResponse

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

Link copied to clipboard
abstract suspend fun getSegmentVersions(input: GetSegmentVersionsRequest): GetSegmentVersionsResponse

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

Link copied to clipboard
abstract suspend fun getSmsChannel(input: GetSmsChannelRequest): GetSmsChannelResponse

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

Link copied to clipboard
abstract suspend fun getSmsTemplate(input: GetSmsTemplateRequest): GetSmsTemplateResponse

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

Link copied to clipboard
abstract suspend fun getUserEndpoints(input: GetUserEndpointsRequest): GetUserEndpointsResponse

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

Link copied to clipboard
abstract suspend fun getVoiceChannel(input: GetVoiceChannelRequest): GetVoiceChannelResponse

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

Link copied to clipboard
abstract suspend fun getVoiceTemplate(input: GetVoiceTemplateRequest): GetVoiceTemplateResponse

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

Link copied to clipboard
abstract suspend fun listJourneys(input: ListJourneysRequest): ListJourneysResponse

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

Link copied to clipboard
abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

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

Link copied to clipboard
abstract suspend fun listTemplates(input: ListTemplatesRequest = ListTemplatesRequest { }): ListTemplatesResponse

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

Link copied to clipboard
abstract suspend fun listTemplateVersions(input: ListTemplateVersionsRequest): ListTemplateVersionsResponse

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

Link copied to clipboard
abstract suspend fun phoneNumberValidate(input: PhoneNumberValidateRequest): PhoneNumberValidateResponse

Retrieves information about a phone number.

Link copied to clipboard
abstract suspend fun putEvents(input: PutEventsRequest): PutEventsResponse

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

Link copied to clipboard
abstract suspend fun putEventStream(input: PutEventStreamRequest): PutEventStreamResponse

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

Link copied to clipboard
abstract suspend fun removeAttributes(input: RemoveAttributesRequest): RemoveAttributesResponse

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.

Link copied to clipboard
abstract suspend fun sendMessages(input: SendMessagesRequest): SendMessagesResponse

Creates and sends a direct message.

Link copied to clipboard
abstract suspend fun sendOtpMessage(input: SendOtpMessageRequest): SendOtpMessageResponse

Send an OTP message

Link copied to clipboard
abstract suspend fun sendUsersMessages(input: SendUsersMessagesRequest): SendUsersMessagesResponse

Creates and sends a message to a list of users.

Link copied to clipboard
abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

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

Link copied to clipboard
abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

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

Link copied to clipboard
abstract suspend fun updateAdmChannel(input: UpdateAdmChannelRequest): UpdateAdmChannelResponse

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

Link copied to clipboard
abstract suspend fun updateApnsChannel(input: UpdateApnsChannelRequest): UpdateApnsChannelResponse

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

Link copied to clipboard
abstract suspend fun updateApnsSandboxChannel(input: UpdateApnsSandboxChannelRequest): UpdateApnsSandboxChannelResponse

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

Link copied to clipboard
abstract suspend fun updateApnsVoipChannel(input: UpdateApnsVoipChannelRequest): UpdateApnsVoipChannelResponse

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

Link copied to clipboard
abstract suspend fun updateApnsVoipSandboxChannel(input: UpdateApnsVoipSandboxChannelRequest): UpdateApnsVoipSandboxChannelResponse

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

Link copied to clipboard
abstract suspend fun updateApplicationSettings(input: UpdateApplicationSettingsRequest): UpdateApplicationSettingsResponse

Updates the settings for an application.

Link copied to clipboard
abstract suspend fun updateBaiduChannel(input: UpdateBaiduChannelRequest): UpdateBaiduChannelResponse

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

Link copied to clipboard
abstract suspend fun updateCampaign(input: UpdateCampaignRequest): UpdateCampaignResponse

Updates the configuration and other settings for a campaign.

Link copied to clipboard
abstract suspend fun updateEmailChannel(input: UpdateEmailChannelRequest): UpdateEmailChannelResponse

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

Link copied to clipboard
abstract suspend fun updateEmailTemplate(input: UpdateEmailTemplateRequest): UpdateEmailTemplateResponse

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

Link copied to clipboard
abstract suspend fun updateEndpoint(input: UpdateEndpointRequest): UpdateEndpointResponse

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.

Link copied to clipboard
abstract suspend fun updateEndpointsBatch(input: UpdateEndpointsBatchRequest): UpdateEndpointsBatchResponse

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.

Link copied to clipboard
abstract suspend fun updateGcmChannel(input: UpdateGcmChannelRequest): UpdateGcmChannelResponse

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

Link copied to clipboard
abstract suspend fun updateInAppTemplate(input: UpdateInAppTemplateRequest): UpdateInAppTemplateResponse

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

Link copied to clipboard
abstract suspend fun updateJourney(input: UpdateJourneyRequest): UpdateJourneyResponse

Updates the configuration and other settings for a journey.

Link copied to clipboard
abstract suspend fun updateJourneyState(input: UpdateJourneyStateRequest): UpdateJourneyStateResponse

Cancels (stops) an active journey.

Link copied to clipboard
abstract suspend fun updatePushTemplate(input: UpdatePushTemplateRequest): UpdatePushTemplateResponse

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

Link copied to clipboard
abstract suspend fun updateRecommenderConfiguration(input: UpdateRecommenderConfigurationRequest): UpdateRecommenderConfigurationResponse

Updates an Amazon Pinpoint configuration for a recommender model.

Link copied to clipboard
abstract suspend fun updateSegment(input: UpdateSegmentRequest): UpdateSegmentResponse

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.

Link copied to clipboard
abstract suspend fun updateSmsChannel(input: UpdateSmsChannelRequest): UpdateSmsChannelResponse

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

Link copied to clipboard
abstract suspend fun updateSmsTemplate(input: UpdateSmsTemplateRequest): UpdateSmsTemplateResponse

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

Link copied to clipboard
abstract suspend fun updateTemplateActiveVersion(input: UpdateTemplateActiveVersionRequest): UpdateTemplateActiveVersionResponse

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

Link copied to clipboard
abstract suspend fun updateVoiceChannel(input: UpdateVoiceChannelRequest): UpdateVoiceChannelResponse

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

Link copied to clipboard
abstract suspend fun updateVoiceTemplate(input: UpdateVoiceTemplateRequest): UpdateVoiceTemplateResponse

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

Link copied to clipboard
abstract suspend fun verifyOtpMessage(input: VerifyOtpMessageRequest): VerifyOtpMessageResponse

Verify an OTP

Inherited functions

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard
inline suspend fun PinpointClient.createApp(crossinline block: CreateAppRequest.Builder.() -> Unit): CreateAppResponse

Creates an application.

Link copied to clipboard
inline suspend fun PinpointClient.createCampaign(crossinline block: CreateCampaignRequest.Builder.() -> Unit): CreateCampaignResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.createEmailTemplate(crossinline block: CreateEmailTemplateRequest.Builder.() -> Unit): CreateEmailTemplateResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.createExportJob(crossinline block: CreateExportJobRequest.Builder.() -> Unit): CreateExportJobResponse

Creates an export job for an application.

Link copied to clipboard
inline suspend fun PinpointClient.createImportJob(crossinline block: CreateImportJobRequest.Builder.() -> Unit): CreateImportJobResponse

Creates an import job for an application.

Link copied to clipboard
inline suspend fun PinpointClient.createInAppTemplate(crossinline block: CreateInAppTemplateRequest.Builder.() -> Unit): CreateInAppTemplateResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.createJourney(crossinline block: CreateJourneyRequest.Builder.() -> Unit): CreateJourneyResponse

Creates a journey for an application.

Link copied to clipboard
inline suspend fun PinpointClient.createPushTemplate(crossinline block: CreatePushTemplateRequest.Builder.() -> Unit): CreatePushTemplateResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.createRecommenderConfiguration(crossinline block: CreateRecommenderConfigurationRequest.Builder.() -> Unit): CreateRecommenderConfigurationResponse

Creates an Amazon Pinpoint configuration for a recommender model.

Link copied to clipboard
inline suspend fun PinpointClient.createSegment(crossinline block: CreateSegmentRequest.Builder.() -> Unit): CreateSegmentResponse

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.

Link copied to clipboard
inline suspend fun PinpointClient.createSmsTemplate(crossinline block: CreateSmsTemplateRequest.Builder.() -> Unit): CreateSmsTemplateResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.createVoiceTemplate(crossinline block: CreateVoiceTemplateRequest.Builder.() -> Unit): CreateVoiceTemplateResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.deleteAdmChannel(crossinline block: DeleteAdmChannelRequest.Builder.() -> Unit): DeleteAdmChannelResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.deleteApnsChannel(crossinline block: DeleteApnsChannelRequest.Builder.() -> Unit): DeleteApnsChannelResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.deleteApnsSandboxChannel(crossinline block: DeleteApnsSandboxChannelRequest.Builder.() -> Unit): DeleteApnsSandboxChannelResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.deleteApnsVoipChannel(crossinline block: DeleteApnsVoipChannelRequest.Builder.() -> Unit): DeleteApnsVoipChannelResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.deleteApnsVoipSandboxChannel(crossinline block: DeleteApnsVoipSandboxChannelRequest.Builder.() -> Unit): DeleteApnsVoipSandboxChannelResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.deleteApp(crossinline block: DeleteAppRequest.Builder.() -> Unit): DeleteAppResponse

Deletes an application.

Link copied to clipboard
inline suspend fun PinpointClient.deleteBaiduChannel(crossinline block: DeleteBaiduChannelRequest.Builder.() -> Unit): DeleteBaiduChannelResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.deleteCampaign(crossinline block: DeleteCampaignRequest.Builder.() -> Unit): DeleteCampaignResponse

Deletes a campaign from an application.

Link copied to clipboard
inline suspend fun PinpointClient.deleteEmailChannel(crossinline block: DeleteEmailChannelRequest.Builder.() -> Unit): DeleteEmailChannelResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.deleteEmailTemplate(crossinline block: DeleteEmailTemplateRequest.Builder.() -> Unit): DeleteEmailTemplateResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.deleteEndpoint(crossinline block: DeleteEndpointRequest.Builder.() -> Unit): DeleteEndpointResponse

Deletes an endpoint from an application.

Link copied to clipboard
inline suspend fun PinpointClient.deleteEventStream(crossinline block: DeleteEventStreamRequest.Builder.() -> Unit): DeleteEventStreamResponse

Deletes the event stream for an application.

Link copied to clipboard
inline suspend fun PinpointClient.deleteGcmChannel(crossinline block: DeleteGcmChannelRequest.Builder.() -> Unit): DeleteGcmChannelResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.deleteInAppTemplate(crossinline block: DeleteInAppTemplateRequest.Builder.() -> Unit): DeleteInAppTemplateResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.deleteJourney(crossinline block: DeleteJourneyRequest.Builder.() -> Unit): DeleteJourneyResponse

Deletes a journey from an application.

Link copied to clipboard
inline suspend fun PinpointClient.deletePushTemplate(crossinline block: DeletePushTemplateRequest.Builder.() -> Unit): DeletePushTemplateResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.deleteRecommenderConfiguration(crossinline block: DeleteRecommenderConfigurationRequest.Builder.() -> Unit): DeleteRecommenderConfigurationResponse

Deletes an Amazon Pinpoint configuration for a recommender model.

Link copied to clipboard
inline suspend fun PinpointClient.deleteSegment(crossinline block: DeleteSegmentRequest.Builder.() -> Unit): DeleteSegmentResponse

Deletes a segment from an application.

Link copied to clipboard
inline suspend fun PinpointClient.deleteSmsChannel(crossinline block: DeleteSmsChannelRequest.Builder.() -> Unit): DeleteSmsChannelResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.deleteSmsTemplate(crossinline block: DeleteSmsTemplateRequest.Builder.() -> Unit): DeleteSmsTemplateResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.deleteUserEndpoints(crossinline block: DeleteUserEndpointsRequest.Builder.() -> Unit): DeleteUserEndpointsResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.deleteVoiceChannel(crossinline block: DeleteVoiceChannelRequest.Builder.() -> Unit): DeleteVoiceChannelResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.deleteVoiceTemplate(crossinline block: DeleteVoiceTemplateRequest.Builder.() -> Unit): DeleteVoiceTemplateResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.getAdmChannel(crossinline block: GetAdmChannelRequest.Builder.() -> Unit): GetAdmChannelResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.getApnsChannel(crossinline block: GetApnsChannelRequest.Builder.() -> Unit): GetApnsChannelResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.getApnsSandboxChannel(crossinline block: GetApnsSandboxChannelRequest.Builder.() -> Unit): GetApnsSandboxChannelResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.getApnsVoipChannel(crossinline block: GetApnsVoipChannelRequest.Builder.() -> Unit): GetApnsVoipChannelResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.getApnsVoipSandboxChannel(crossinline block: GetApnsVoipSandboxChannelRequest.Builder.() -> Unit): GetApnsVoipSandboxChannelResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.getApp(crossinline block: GetAppRequest.Builder.() -> Unit): GetAppResponse

Retrieves information about an application.

Link copied to clipboard
inline suspend fun PinpointClient.getApplicationDateRangeKpi(crossinline block: GetApplicationDateRangeKpiRequest.Builder.() -> Unit): GetApplicationDateRangeKpiResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.getApplicationSettings(crossinline block: GetApplicationSettingsRequest.Builder.() -> Unit): GetApplicationSettingsResponse

Retrieves information about the settings for an application.

Link copied to clipboard
inline suspend fun PinpointClient.getApps(crossinline block: GetAppsRequest.Builder.() -> Unit): GetAppsResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.getBaiduChannel(crossinline block: GetBaiduChannelRequest.Builder.() -> Unit): GetBaiduChannelResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.getCampaign(crossinline block: GetCampaignRequest.Builder.() -> Unit): GetCampaignResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.getCampaignActivities(crossinline block: GetCampaignActivitiesRequest.Builder.() -> Unit): GetCampaignActivitiesResponse

Retrieves information about all the activities for a campaign.

Link copied to clipboard
inline suspend fun PinpointClient.getCampaignDateRangeKpi(crossinline block: GetCampaignDateRangeKpiRequest.Builder.() -> Unit): GetCampaignDateRangeKpiResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.getCampaigns(crossinline block: GetCampaignsRequest.Builder.() -> Unit): GetCampaignsResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.getCampaignVersion(crossinline block: GetCampaignVersionRequest.Builder.() -> Unit): GetCampaignVersionResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.getCampaignVersions(crossinline block: GetCampaignVersionsRequest.Builder.() -> Unit): GetCampaignVersionsResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.getChannels(crossinline block: GetChannelsRequest.Builder.() -> Unit): GetChannelsResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.getEmailChannel(crossinline block: GetEmailChannelRequest.Builder.() -> Unit): GetEmailChannelResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.getEmailTemplate(crossinline block: GetEmailTemplateRequest.Builder.() -> Unit): GetEmailTemplateResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.getEndpoint(crossinline block: GetEndpointRequest.Builder.() -> Unit): GetEndpointResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.getEventStream(crossinline block: GetEventStreamRequest.Builder.() -> Unit): GetEventStreamResponse

Retrieves information about the event stream settings for an application.

Link copied to clipboard
inline suspend fun PinpointClient.getExportJob(crossinline block: GetExportJobRequest.Builder.() -> Unit): GetExportJobResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.getExportJobs(crossinline block: GetExportJobsRequest.Builder.() -> Unit): GetExportJobsResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.getGcmChannel(crossinline block: GetGcmChannelRequest.Builder.() -> Unit): GetGcmChannelResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.getImportJob(crossinline block: GetImportJobRequest.Builder.() -> Unit): GetImportJobResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.getImportJobs(crossinline block: GetImportJobsRequest.Builder.() -> Unit): GetImportJobsResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.getInAppMessages(crossinline block: GetInAppMessagesRequest.Builder.() -> Unit): GetInAppMessagesResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.getInAppTemplate(crossinline block: GetInAppTemplateRequest.Builder.() -> Unit): GetInAppTemplateResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.getJourney(crossinline block: GetJourneyRequest.Builder.() -> Unit): GetJourneyResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.getJourneyDateRangeKpi(crossinline block: GetJourneyDateRangeKpiRequest.Builder.() -> Unit): GetJourneyDateRangeKpiResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.getJourneyExecutionActivityMetrics(crossinline block: GetJourneyExecutionActivityMetricsRequest.Builder.() -> Unit): GetJourneyExecutionActivityMetricsResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.getJourneyExecutionMetrics(crossinline block: GetJourneyExecutionMetricsRequest.Builder.() -> Unit): GetJourneyExecutionMetricsResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.getJourneyRunExecutionActivityMetrics(crossinline block: GetJourneyRunExecutionActivityMetricsRequest.Builder.() -> Unit): GetJourneyRunExecutionActivityMetricsResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.getJourneyRunExecutionMetrics(crossinline block: GetJourneyRunExecutionMetricsRequest.Builder.() -> Unit): GetJourneyRunExecutionMetricsResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.getJourneyRuns(crossinline block: GetJourneyRunsRequest.Builder.() -> Unit): GetJourneyRunsResponse

Provides information about the runs of a journey.

Link copied to clipboard
inline suspend fun PinpointClient.getPushTemplate(crossinline block: GetPushTemplateRequest.Builder.() -> Unit): GetPushTemplateResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.getRecommenderConfiguration(crossinline block: GetRecommenderConfigurationRequest.Builder.() -> Unit): GetRecommenderConfigurationResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.getRecommenderConfigurations(crossinline block: GetRecommenderConfigurationsRequest.Builder.() -> Unit): GetRecommenderConfigurationsResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.getSegment(crossinline block: GetSegmentRequest.Builder.() -> Unit): GetSegmentResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.getSegmentExportJobs(crossinline block: GetSegmentExportJobsRequest.Builder.() -> Unit): GetSegmentExportJobsResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.getSegmentImportJobs(crossinline block: GetSegmentImportJobsRequest.Builder.() -> Unit): GetSegmentImportJobsResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.getSegments(crossinline block: GetSegmentsRequest.Builder.() -> Unit): GetSegmentsResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.getSegmentVersion(crossinline block: GetSegmentVersionRequest.Builder.() -> Unit): GetSegmentVersionResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.getSegmentVersions(crossinline block: GetSegmentVersionsRequest.Builder.() -> Unit): GetSegmentVersionsResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.getSmsChannel(crossinline block: GetSmsChannelRequest.Builder.() -> Unit): GetSmsChannelResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.getSmsTemplate(crossinline block: GetSmsTemplateRequest.Builder.() -> Unit): GetSmsTemplateResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.getUserEndpoints(crossinline block: GetUserEndpointsRequest.Builder.() -> Unit): GetUserEndpointsResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.getVoiceChannel(crossinline block: GetVoiceChannelRequest.Builder.() -> Unit): GetVoiceChannelResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.getVoiceTemplate(crossinline block: GetVoiceTemplateRequest.Builder.() -> Unit): GetVoiceTemplateResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.listJourneys(crossinline block: ListJourneysRequest.Builder.() -> Unit): ListJourneysResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.listTemplates(crossinline block: ListTemplatesRequest.Builder.() -> Unit): ListTemplatesResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.listTemplateVersions(crossinline block: ListTemplateVersionsRequest.Builder.() -> Unit): ListTemplateVersionsResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.phoneNumberValidate(crossinline block: PhoneNumberValidateRequest.Builder.() -> Unit): PhoneNumberValidateResponse

Retrieves information about a phone number.

Link copied to clipboard
inline suspend fun PinpointClient.putEvents(crossinline block: PutEventsRequest.Builder.() -> Unit): PutEventsResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.putEventStream(crossinline block: PutEventStreamRequest.Builder.() -> Unit): PutEventStreamResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.removeAttributes(crossinline block: RemoveAttributesRequest.Builder.() -> Unit): RemoveAttributesResponse

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.

Link copied to clipboard
inline suspend fun PinpointClient.sendMessages(crossinline block: SendMessagesRequest.Builder.() -> Unit): SendMessagesResponse

Creates and sends a direct message.

Link copied to clipboard
inline suspend fun PinpointClient.sendOtpMessage(crossinline block: SendOtpMessageRequest.Builder.() -> Unit): SendOtpMessageResponse

Send an OTP message

Link copied to clipboard
inline suspend fun PinpointClient.sendUsersMessages(crossinline block: SendUsersMessagesRequest.Builder.() -> Unit): SendUsersMessagesResponse

Creates and sends a message to a list of users.

Link copied to clipboard
inline suspend fun PinpointClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.updateAdmChannel(crossinline block: UpdateAdmChannelRequest.Builder.() -> Unit): UpdateAdmChannelResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.updateApnsChannel(crossinline block: UpdateApnsChannelRequest.Builder.() -> Unit): UpdateApnsChannelResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.updateApnsSandboxChannel(crossinline block: UpdateApnsSandboxChannelRequest.Builder.() -> Unit): UpdateApnsSandboxChannelResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.updateApnsVoipChannel(crossinline block: UpdateApnsVoipChannelRequest.Builder.() -> Unit): UpdateApnsVoipChannelResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.updateApnsVoipSandboxChannel(crossinline block: UpdateApnsVoipSandboxChannelRequest.Builder.() -> Unit): UpdateApnsVoipSandboxChannelResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.updateApplicationSettings(crossinline block: UpdateApplicationSettingsRequest.Builder.() -> Unit): UpdateApplicationSettingsResponse

Updates the settings for an application.

Link copied to clipboard
inline suspend fun PinpointClient.updateBaiduChannel(crossinline block: UpdateBaiduChannelRequest.Builder.() -> Unit): UpdateBaiduChannelResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.updateCampaign(crossinline block: UpdateCampaignRequest.Builder.() -> Unit): UpdateCampaignResponse

Updates the configuration and other settings for a campaign.

Link copied to clipboard
inline suspend fun PinpointClient.updateEmailChannel(crossinline block: UpdateEmailChannelRequest.Builder.() -> Unit): UpdateEmailChannelResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.updateEmailTemplate(crossinline block: UpdateEmailTemplateRequest.Builder.() -> Unit): UpdateEmailTemplateResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.updateEndpoint(crossinline block: UpdateEndpointRequest.Builder.() -> Unit): UpdateEndpointResponse

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.

Link copied to clipboard
inline suspend fun PinpointClient.updateEndpointsBatch(crossinline block: UpdateEndpointsBatchRequest.Builder.() -> Unit): UpdateEndpointsBatchResponse

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.

Link copied to clipboard
inline suspend fun PinpointClient.updateGcmChannel(crossinline block: UpdateGcmChannelRequest.Builder.() -> Unit): UpdateGcmChannelResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.updateInAppTemplate(crossinline block: UpdateInAppTemplateRequest.Builder.() -> Unit): UpdateInAppTemplateResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.updateJourney(crossinline block: UpdateJourneyRequest.Builder.() -> Unit): UpdateJourneyResponse

Updates the configuration and other settings for a journey.

Link copied to clipboard
inline suspend fun PinpointClient.updateJourneyState(crossinline block: UpdateJourneyStateRequest.Builder.() -> Unit): UpdateJourneyStateResponse

Cancels (stops) an active journey.

Link copied to clipboard
inline suspend fun PinpointClient.updatePushTemplate(crossinline block: UpdatePushTemplateRequest.Builder.() -> Unit): UpdatePushTemplateResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.updateRecommenderConfiguration(crossinline block: UpdateRecommenderConfigurationRequest.Builder.() -> Unit): UpdateRecommenderConfigurationResponse

Updates an Amazon Pinpoint configuration for a recommender model.

Link copied to clipboard
inline suspend fun PinpointClient.updateSegment(crossinline block: UpdateSegmentRequest.Builder.() -> Unit): UpdateSegmentResponse

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.

Link copied to clipboard
inline suspend fun PinpointClient.updateSmsChannel(crossinline block: UpdateSmsChannelRequest.Builder.() -> Unit): UpdateSmsChannelResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.updateSmsTemplate(crossinline block: UpdateSmsTemplateRequest.Builder.() -> Unit): UpdateSmsTemplateResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.updateTemplateActiveVersion(crossinline block: UpdateTemplateActiveVersionRequest.Builder.() -> Unit): UpdateTemplateActiveVersionResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.updateVoiceChannel(crossinline block: UpdateVoiceChannelRequest.Builder.() -> Unit): UpdateVoiceChannelResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.updateVoiceTemplate(crossinline block: UpdateVoiceTemplateRequest.Builder.() -> Unit): UpdateVoiceTemplateResponse

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

Link copied to clipboard
inline suspend fun PinpointClient.verifyOtpMessage(crossinline block: VerifyOtpMessageRequest.Builder.() -> Unit): VerifyOtpMessageResponse

Verify an OTP

Link copied to clipboard
fun PinpointClient.withConfig(block: PinpointClient.Config.Builder.() -> Unit): PinpointClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.