AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Implementation for accessing Pinpoint

Doc Engage API - Amazon Pinpoint API

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.Pinpoint.AmazonPinpointClient

Namespace: Amazon.Pinpoint
Assembly: AWSSDK.Pinpoint.dll
Version: 3.x.y.z

Syntax

C#
public class AmazonPinpointClient : AmazonServiceClient
         IAmazonPinpoint, IAmazonService, IDisposable

The AmazonPinpointClient type exposes the following members

Constructors

NameDescription
Public Method AmazonPinpointClient()

Constructs AmazonPinpointClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             

Public Method AmazonPinpointClient(RegionEndpoint)

Constructs AmazonPinpointClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             

Public Method AmazonPinpointClient(AmazonPinpointConfig)

Constructs AmazonPinpointClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             

Public Method AmazonPinpointClient(AWSCredentials)

Constructs AmazonPinpointClient with AWS Credentials

Public Method AmazonPinpointClient(AWSCredentials, RegionEndpoint)

Constructs AmazonPinpointClient with AWS Credentials

Public Method AmazonPinpointClient(AWSCredentials, AmazonPinpointConfig)

Constructs AmazonPinpointClient with AWS Credentials and an AmazonPinpointClient Configuration object.

Public Method AmazonPinpointClient(string, string)

Constructs AmazonPinpointClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonPinpointClient(string, string, RegionEndpoint)

Constructs AmazonPinpointClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonPinpointClient(string, string, AmazonPinpointConfig)

Constructs AmazonPinpointClient with AWS Access Key ID, AWS Secret Key and an AmazonPinpointClient Configuration object.

Public Method AmazonPinpointClient(string, string, string)

Constructs AmazonPinpointClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonPinpointClient(string, string, string, RegionEndpoint)

Constructs AmazonPinpointClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonPinpointClient(string, string, string, AmazonPinpointConfig)

Constructs AmazonPinpointClient with AWS Access Key ID, AWS Secret Key and an AmazonPinpointClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method CreateApp(CreateAppRequest)

Creates an application.

Public Method CreateAppAsync(CreateAppRequest, CancellationToken)

Creates an application.

Public Method CreateCampaign(CreateCampaignRequest)

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

Public Method CreateCampaignAsync(CreateCampaignRequest, CancellationToken)

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

Public Method CreateEmailTemplate(CreateEmailTemplateRequest)

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

Public Method CreateEmailTemplateAsync(CreateEmailTemplateRequest, CancellationToken)

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

Public Method CreateExportJob(CreateExportJobRequest)

Creates an export job for an application.

Public Method CreateExportJobAsync(CreateExportJobRequest, CancellationToken)

Creates an export job for an application.

Public Method CreateImportJob(CreateImportJobRequest)

Creates an import job for an application.

Public Method CreateImportJobAsync(CreateImportJobRequest, CancellationToken)

Creates an import job for an application.

Public Method CreateInAppTemplate(CreateInAppTemplateRequest)

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

Public Method CreateInAppTemplateAsync(CreateInAppTemplateRequest, CancellationToken)

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

Public Method CreateJourney(CreateJourneyRequest)

Creates a journey for an application.

Public Method CreateJourneyAsync(CreateJourneyRequest, CancellationToken)

Creates a journey for an application.

Public Method CreatePushTemplate(CreatePushTemplateRequest)

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

Public Method CreatePushTemplateAsync(CreatePushTemplateRequest, CancellationToken)

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

Public Method CreateRecommenderConfiguration(CreateRecommenderConfigurationRequest)

Creates an Amazon Pinpoint configuration for a recommender model.

Public Method CreateRecommenderConfigurationAsync(CreateRecommenderConfigurationRequest, CancellationToken)

Creates an Amazon Pinpoint configuration for a recommender model.

Public Method CreateSegment(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.

Public Method CreateSegmentAsync(CreateSegmentRequest, CancellationToken)

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.

Public Method CreateSmsTemplate(CreateSmsTemplateRequest)

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

Public Method CreateSmsTemplateAsync(CreateSmsTemplateRequest, CancellationToken)

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

Public Method CreateVoiceTemplate(CreateVoiceTemplateRequest)

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

Public Method CreateVoiceTemplateAsync(CreateVoiceTemplateRequest, CancellationToken)

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

Public Method DeleteAdmChannel(DeleteAdmChannelRequest)

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

Public Method DeleteAdmChannelAsync(DeleteAdmChannelRequest, CancellationToken)

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

Public Method DeleteApnsChannel(DeleteApnsChannelRequest)

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

Public Method DeleteApnsChannelAsync(DeleteApnsChannelRequest, CancellationToken)

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

Public Method DeleteApnsSandboxChannel(DeleteApnsSandboxChannelRequest)

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

Public Method DeleteApnsSandboxChannelAsync(DeleteApnsSandboxChannelRequest, CancellationToken)

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

Public Method DeleteApnsVoipChannel(DeleteApnsVoipChannelRequest)

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

Public Method DeleteApnsVoipChannelAsync(DeleteApnsVoipChannelRequest, CancellationToken)

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

Public Method DeleteApnsVoipSandboxChannel(DeleteApnsVoipSandboxChannelRequest)

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

Public Method DeleteApnsVoipSandboxChannelAsync(DeleteApnsVoipSandboxChannelRequest, CancellationToken)

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

Public Method DeleteApp(DeleteAppRequest)

Deletes an application.

Public Method DeleteAppAsync(DeleteAppRequest, CancellationToken)

Deletes an application.

Public Method DeleteBaiduChannel(DeleteBaiduChannelRequest)

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

Public Method DeleteBaiduChannelAsync(DeleteBaiduChannelRequest, CancellationToken)

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

Public Method DeleteCampaign(DeleteCampaignRequest)

Deletes a campaign from an application.

Public Method DeleteCampaignAsync(DeleteCampaignRequest, CancellationToken)

Deletes a campaign from an application.

Public Method DeleteEmailChannel(DeleteEmailChannelRequest)

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

Public Method DeleteEmailChannelAsync(DeleteEmailChannelRequest, CancellationToken)

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

Public Method DeleteEmailTemplate(DeleteEmailTemplateRequest)

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

Public Method DeleteEmailTemplateAsync(DeleteEmailTemplateRequest, CancellationToken)

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

Public Method DeleteEndpoint(DeleteEndpointRequest)

Deletes an endpoint from an application.

Public Method DeleteEndpointAsync(DeleteEndpointRequest, CancellationToken)

Deletes an endpoint from an application.

Public Method DeleteEventStream(DeleteEventStreamRequest)

Deletes the event stream for an application.

Public Method DeleteEventStreamAsync(DeleteEventStreamRequest, CancellationToken)

Deletes the event stream for an application.

Public Method DeleteGcmChannel(DeleteGcmChannelRequest)

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

Public Method DeleteGcmChannelAsync(DeleteGcmChannelRequest, CancellationToken)

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

Public Method DeleteInAppTemplate(DeleteInAppTemplateRequest)

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

Public Method DeleteInAppTemplateAsync(DeleteInAppTemplateRequest, CancellationToken)

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

Public Method DeleteJourney(DeleteJourneyRequest)

Deletes a journey from an application.

Public Method DeleteJourneyAsync(DeleteJourneyRequest, CancellationToken)

Deletes a journey from an application.

Public Method DeletePushTemplate(DeletePushTemplateRequest)

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

Public Method DeletePushTemplateAsync(DeletePushTemplateRequest, CancellationToken)

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

Public Method DeleteRecommenderConfiguration(DeleteRecommenderConfigurationRequest)

Deletes an Amazon Pinpoint configuration for a recommender model.

Public Method DeleteRecommenderConfigurationAsync(DeleteRecommenderConfigurationRequest, CancellationToken)

Deletes an Amazon Pinpoint configuration for a recommender model.

Public Method DeleteSegment(DeleteSegmentRequest)

Deletes a segment from an application.

Public Method DeleteSegmentAsync(DeleteSegmentRequest, CancellationToken)

Deletes a segment from an application.

Public Method DeleteSmsChannel(DeleteSmsChannelRequest)

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

Public Method DeleteSmsChannelAsync(DeleteSmsChannelRequest, CancellationToken)

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

Public Method DeleteSmsTemplate(DeleteSmsTemplateRequest)

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

Public Method DeleteSmsTemplateAsync(DeleteSmsTemplateRequest, CancellationToken)

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

Public Method DeleteUserEndpoints(DeleteUserEndpointsRequest)

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

Public Method DeleteUserEndpointsAsync(DeleteUserEndpointsRequest, CancellationToken)

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

Public Method DeleteVoiceChannel(DeleteVoiceChannelRequest)

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

Public Method DeleteVoiceChannelAsync(DeleteVoiceChannelRequest, CancellationToken)

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

Public Method DeleteVoiceTemplate(DeleteVoiceTemplateRequest)

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

Public Method DeleteVoiceTemplateAsync(DeleteVoiceTemplateRequest, CancellationToken)

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

Public Method DetermineServiceOperationEndpoint(AmazonWebServiceRequest)

Returns the endpoint that will be used for a particular request.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method GetAdmChannel(GetAdmChannelRequest)

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

Public Method GetAdmChannelAsync(GetAdmChannelRequest, CancellationToken)

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

Public Method GetApnsChannel(GetApnsChannelRequest)

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

Public Method GetApnsChannelAsync(GetApnsChannelRequest, CancellationToken)

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

Public Method GetApnsSandboxChannel(GetApnsSandboxChannelRequest)

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

Public Method GetApnsSandboxChannelAsync(GetApnsSandboxChannelRequest, CancellationToken)

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

Public Method GetApnsVoipChannel(GetApnsVoipChannelRequest)

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

Public Method GetApnsVoipChannelAsync(GetApnsVoipChannelRequest, CancellationToken)

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

Public Method GetApnsVoipSandboxChannel(GetApnsVoipSandboxChannelRequest)

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

Public Method GetApnsVoipSandboxChannelAsync(GetApnsVoipSandboxChannelRequest, CancellationToken)

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

Public Method GetApp(GetAppRequest)

Retrieves information about an application.

Public Method GetAppAsync(GetAppRequest, CancellationToken)

Retrieves information about an application.

Public Method GetApplicationDateRangeKpi(GetApplicationDateRangeKpiRequest)

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

Public Method GetApplicationDateRangeKpiAsync(GetApplicationDateRangeKpiRequest, CancellationToken)

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

Public Method GetApplicationSettings(GetApplicationSettingsRequest)

Retrieves information about the settings for an application.

Public Method GetApplicationSettingsAsync(GetApplicationSettingsRequest, CancellationToken)

Retrieves information about the settings for an application.

Public Method GetApps(GetAppsRequest)

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

Public Method GetAppsAsync(GetAppsRequest, CancellationToken)

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

Public Method GetBaiduChannel(GetBaiduChannelRequest)

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

Public Method GetBaiduChannelAsync(GetBaiduChannelRequest, CancellationToken)

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

Public Method GetCampaign(GetCampaignRequest)

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

Public Method GetCampaignActivities(GetCampaignActivitiesRequest)

Retrieves information about all the activities for a campaign.

Public Method GetCampaignActivitiesAsync(GetCampaignActivitiesRequest, CancellationToken)

Retrieves information about all the activities for a campaign.

Public Method GetCampaignAsync(GetCampaignRequest, CancellationToken)

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

Public Method GetCampaignDateRangeKpi(GetCampaignDateRangeKpiRequest)

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

Public Method GetCampaignDateRangeKpiAsync(GetCampaignDateRangeKpiRequest, CancellationToken)

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

Public Method GetCampaigns(GetCampaignsRequest)

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

Public Method GetCampaignsAsync(GetCampaignsRequest, CancellationToken)

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

Public Method GetCampaignVersion(GetCampaignVersionRequest)

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

Public Method GetCampaignVersionAsync(GetCampaignVersionRequest, CancellationToken)

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

Public Method GetCampaignVersions(GetCampaignVersionsRequest)

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

Public Method GetCampaignVersionsAsync(GetCampaignVersionsRequest, CancellationToken)

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

Public Method GetChannels(GetChannelsRequest)

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

Public Method GetChannelsAsync(GetChannelsRequest, CancellationToken)

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

Public Method GetEmailChannel(GetEmailChannelRequest)

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

Public Method GetEmailChannelAsync(GetEmailChannelRequest, CancellationToken)

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

Public Method GetEmailTemplate(GetEmailTemplateRequest)

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

Public Method GetEmailTemplateAsync(GetEmailTemplateRequest, CancellationToken)

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

Public Method GetEndpoint(GetEndpointRequest)

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

Public Method GetEndpointAsync(GetEndpointRequest, CancellationToken)

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

Public Method GetEventStream(GetEventStreamRequest)

Retrieves information about the event stream settings for an application.

Public Method GetEventStreamAsync(GetEventStreamRequest, CancellationToken)

Retrieves information about the event stream settings for an application.

Public Method GetExportJob(GetExportJobRequest)

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

Public Method GetExportJobAsync(GetExportJobRequest, CancellationToken)

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

Public Method GetExportJobs(GetExportJobsRequest)

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

Public Method GetExportJobsAsync(GetExportJobsRequest, CancellationToken)

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

Public Method GetGcmChannel(GetGcmChannelRequest)

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

Public Method GetGcmChannelAsync(GetGcmChannelRequest, CancellationToken)

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

Public Method GetImportJob(GetImportJobRequest)

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

Public Method GetImportJobAsync(GetImportJobRequest, CancellationToken)

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

Public Method GetImportJobs(GetImportJobsRequest)

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

Public Method GetImportJobsAsync(GetImportJobsRequest, CancellationToken)

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

Public Method GetInAppMessages(GetInAppMessagesRequest)

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

Public Method GetInAppMessagesAsync(GetInAppMessagesRequest, CancellationToken)

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

Public Method GetInAppTemplate(GetInAppTemplateRequest)

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

Public Method GetInAppTemplateAsync(GetInAppTemplateRequest, CancellationToken)

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

Public Method GetJourney(GetJourneyRequest)

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

Public Method GetJourneyAsync(GetJourneyRequest, CancellationToken)

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

Public Method GetJourneyDateRangeKpi(GetJourneyDateRangeKpiRequest)

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

Public Method GetJourneyDateRangeKpiAsync(GetJourneyDateRangeKpiRequest, CancellationToken)

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

Public Method GetJourneyExecutionActivityMetrics(GetJourneyExecutionActivityMetricsRequest)

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

Public Method GetJourneyExecutionActivityMetricsAsync(GetJourneyExecutionActivityMetricsRequest, CancellationToken)

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

Public Method GetJourneyExecutionMetrics(GetJourneyExecutionMetricsRequest)

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

Public Method GetJourneyExecutionMetricsAsync(GetJourneyExecutionMetricsRequest, CancellationToken)

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

Public Method GetJourneyRunExecutionActivityMetrics(GetJourneyRunExecutionActivityMetricsRequest)

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

Public Method GetJourneyRunExecutionActivityMetricsAsync(GetJourneyRunExecutionActivityMetricsRequest, CancellationToken)

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

Public Method GetJourneyRunExecutionMetrics(GetJourneyRunExecutionMetricsRequest)

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

Public Method GetJourneyRunExecutionMetricsAsync(GetJourneyRunExecutionMetricsRequest, CancellationToken)

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

Public Method GetJourneyRuns(GetJourneyRunsRequest)

Provides information about the runs of a journey.

Public Method GetJourneyRunsAsync(GetJourneyRunsRequest, CancellationToken)

Provides information about the runs of a journey.

Public Method GetPushTemplate(GetPushTemplateRequest)

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

Public Method GetPushTemplateAsync(GetPushTemplateRequest, CancellationToken)

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

Public Method GetRecommenderConfiguration(GetRecommenderConfigurationRequest)

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

Public Method GetRecommenderConfigurationAsync(GetRecommenderConfigurationRequest, CancellationToken)

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

Public Method GetRecommenderConfigurations(GetRecommenderConfigurationsRequest)

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

Public Method GetRecommenderConfigurationsAsync(GetRecommenderConfigurationsRequest, CancellationToken)

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

Public Method GetSegment(GetSegmentRequest)

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

Public Method GetSegmentAsync(GetSegmentRequest, CancellationToken)

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

Public Method GetSegmentExportJobs(GetSegmentExportJobsRequest)

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

Public Method GetSegmentExportJobsAsync(GetSegmentExportJobsRequest, CancellationToken)

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

Public Method GetSegmentImportJobs(GetSegmentImportJobsRequest)

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

Public Method GetSegmentImportJobsAsync(GetSegmentImportJobsRequest, CancellationToken)

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

Public Method GetSegments(GetSegmentsRequest)

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

Public Method GetSegmentsAsync(GetSegmentsRequest, CancellationToken)

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

Public Method GetSegmentVersion(GetSegmentVersionRequest)

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

Public Method GetSegmentVersionAsync(GetSegmentVersionRequest, CancellationToken)

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

Public Method GetSegmentVersions(GetSegmentVersionsRequest)

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

Public Method GetSegmentVersionsAsync(GetSegmentVersionsRequest, CancellationToken)

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

Public Method GetSmsChannel(GetSmsChannelRequest)

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

Public Method GetSmsChannelAsync(GetSmsChannelRequest, CancellationToken)

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

Public Method GetSmsTemplate(GetSmsTemplateRequest)

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

Public Method GetSmsTemplateAsync(GetSmsTemplateRequest, CancellationToken)

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

Public Method GetUserEndpoints(GetUserEndpointsRequest)

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

Public Method GetUserEndpointsAsync(GetUserEndpointsRequest, CancellationToken)

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

Public Method GetVoiceChannel(GetVoiceChannelRequest)

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

Public Method GetVoiceChannelAsync(GetVoiceChannelRequest, CancellationToken)

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

Public Method GetVoiceTemplate(GetVoiceTemplateRequest)

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

Public Method GetVoiceTemplateAsync(GetVoiceTemplateRequest, CancellationToken)

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

Public Method ListJourneys(ListJourneysRequest)

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

Public Method ListJourneysAsync(ListJourneysRequest, CancellationToken)

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

Public Method ListTagsForResource(ListTagsForResourceRequest)

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

Public Method ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken)

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

Public Method ListTemplates(ListTemplatesRequest)

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

Public Method ListTemplatesAsync(ListTemplatesRequest, CancellationToken)

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

Public Method ListTemplateVersions(ListTemplateVersionsRequest)

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

Public Method ListTemplateVersionsAsync(ListTemplateVersionsRequest, CancellationToken)

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

Public Method PhoneNumberValidate(PhoneNumberValidateRequest)

Retrieves information about a phone number.

Public Method PhoneNumberValidateAsync(PhoneNumberValidateRequest, CancellationToken)

Retrieves information about a phone number.

Public Method PutEvents(PutEventsRequest)

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

Public Method PutEventsAsync(PutEventsRequest, CancellationToken)

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

Public Method PutEventStream(PutEventStreamRequest)

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

Public Method PutEventStreamAsync(PutEventStreamRequest, CancellationToken)

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

Public Method RemoveAttributes(RemoveAttributesRequest)

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.

Public Method RemoveAttributesAsync(RemoveAttributesRequest, CancellationToken)

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.

Public Method SendMessages(SendMessagesRequest)

Creates and sends a direct message.

Public Method SendMessagesAsync(SendMessagesRequest, CancellationToken)

Creates and sends a direct message.

Public Method SendOTPMessage(SendOTPMessageRequest)

Send an OTP message

Public Method SendOTPMessageAsync(SendOTPMessageRequest, CancellationToken)

Send an OTP message

Public Method SendUsersMessages(SendUsersMessagesRequest)

Creates and sends a message to a list of users.

Public Method SendUsersMessagesAsync(SendUsersMessagesRequest, CancellationToken)

Creates and sends a message to a list of users.

Public Method TagResource(TagResourceRequest)

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

Public Method TagResourceAsync(TagResourceRequest, CancellationToken)

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

Public Method UntagResource(UntagResourceRequest)

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

Public Method UntagResourceAsync(UntagResourceRequest, CancellationToken)

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

Public Method UpdateAdmChannel(UpdateAdmChannelRequest)

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

Public Method UpdateAdmChannelAsync(UpdateAdmChannelRequest, CancellationToken)

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

Public Method UpdateApnsChannel(UpdateApnsChannelRequest)

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

Public Method UpdateApnsChannelAsync(UpdateApnsChannelRequest, CancellationToken)

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

Public Method UpdateApnsSandboxChannel(UpdateApnsSandboxChannelRequest)

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

Public Method UpdateApnsSandboxChannelAsync(UpdateApnsSandboxChannelRequest, CancellationToken)

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

Public Method UpdateApnsVoipChannel(UpdateApnsVoipChannelRequest)

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

Public Method UpdateApnsVoipChannelAsync(UpdateApnsVoipChannelRequest, CancellationToken)

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

Public Method UpdateApnsVoipSandboxChannel(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.

Public Method UpdateApnsVoipSandboxChannelAsync(UpdateApnsVoipSandboxChannelRequest, CancellationToken)

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

Public Method UpdateApplicationSettings(UpdateApplicationSettingsRequest)

Updates the settings for an application.

Public Method UpdateApplicationSettingsAsync(UpdateApplicationSettingsRequest, CancellationToken)

Updates the settings for an application.

Public Method UpdateBaiduChannel(UpdateBaiduChannelRequest)

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

Public Method UpdateBaiduChannelAsync(UpdateBaiduChannelRequest, CancellationToken)

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

Public Method UpdateCampaign(UpdateCampaignRequest)

Updates the configuration and other settings for a campaign.

Public Method UpdateCampaignAsync(UpdateCampaignRequest, CancellationToken)

Updates the configuration and other settings for a campaign.

Public Method UpdateEmailChannel(UpdateEmailChannelRequest)

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

Public Method UpdateEmailChannelAsync(UpdateEmailChannelRequest, CancellationToken)

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

Public Method UpdateEmailTemplate(UpdateEmailTemplateRequest)

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

Public Method UpdateEmailTemplateAsync(UpdateEmailTemplateRequest, CancellationToken)

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

Public Method UpdateEndpoint(UpdateEndpointRequest)

Creates a new endpoint for an application or updates the settings and attributes of an existing endpoint for an application. You can also use this operation to define custom attributes for an endpoint. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values.

Public Method UpdateEndpointAsync(UpdateEndpointRequest, CancellationToken)

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.

Public Method UpdateEndpointsBatch(UpdateEndpointsBatchRequest)

Creates a new batch of endpoints for an application or updates the settings and attributes of a batch of existing endpoints for an application. You can also use this operation to define custom attributes for a batch of endpoints. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values.

Public Method UpdateEndpointsBatchAsync(UpdateEndpointsBatchRequest, CancellationToken)

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.

Public Method UpdateGcmChannel(UpdateGcmChannelRequest)

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

Public Method UpdateGcmChannelAsync(UpdateGcmChannelRequest, CancellationToken)

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

Public Method UpdateInAppTemplate(UpdateInAppTemplateRequest)

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

Public Method UpdateInAppTemplateAsync(UpdateInAppTemplateRequest, CancellationToken)

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

Public Method UpdateJourney(UpdateJourneyRequest)

Updates the configuration and other settings for a journey.

Public Method UpdateJourneyAsync(UpdateJourneyRequest, CancellationToken)

Updates the configuration and other settings for a journey.

Public Method UpdateJourneyState(UpdateJourneyStateRequest)

Cancels (stops) an active journey.

Public Method UpdateJourneyStateAsync(UpdateJourneyStateRequest, CancellationToken)

Cancels (stops) an active journey.

Public Method UpdatePushTemplate(UpdatePushTemplateRequest)

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

Public Method UpdatePushTemplateAsync(UpdatePushTemplateRequest, CancellationToken)

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

Public Method UpdateRecommenderConfiguration(UpdateRecommenderConfigurationRequest)

Updates an Amazon Pinpoint configuration for a recommender model.

Public Method UpdateRecommenderConfigurationAsync(UpdateRecommenderConfigurationRequest, CancellationToken)

Updates an Amazon Pinpoint configuration for a recommender model.

Public Method UpdateSegment(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.

Public Method UpdateSegmentAsync(UpdateSegmentRequest, CancellationToken)

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.

Public Method UpdateSmsChannel(UpdateSmsChannelRequest)

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

Public Method UpdateSmsChannelAsync(UpdateSmsChannelRequest, CancellationToken)

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

Public Method UpdateSmsTemplate(UpdateSmsTemplateRequest)

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

Public Method UpdateSmsTemplateAsync(UpdateSmsTemplateRequest, CancellationToken)

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

Public Method UpdateTemplateActiveVersion(UpdateTemplateActiveVersionRequest)

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

Public Method UpdateTemplateActiveVersionAsync(UpdateTemplateActiveVersionRequest, CancellationToken)

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

Public Method UpdateVoiceChannel(UpdateVoiceChannelRequest)

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

Public Method UpdateVoiceChannelAsync(UpdateVoiceChannelRequest, CancellationToken)

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

Public Method UpdateVoiceTemplate(UpdateVoiceTemplateRequest)

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

Public Method UpdateVoiceTemplateAsync(UpdateVoiceTemplateRequest, CancellationToken)

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

Public Method VerifyOTPMessage(VerifyOTPMessageRequest)

Verify an OTP

Public Method VerifyOTPMessageAsync(VerifyOTPMessageRequest, CancellationToken)

Verify an OTP

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5