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

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.



    
        
    

             

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.



    
        
    

             

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.



    
        
    

             

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 or updates an app.

Public Method CreateAppAsync(CreateAppRequest, CancellationToken)

Initiates the asynchronous execution of the CreateApp operation.

Public Method CreateCampaign(CreateCampaignRequest)

Creates or updates a campaign.

Public Method CreateCampaignAsync(CreateCampaignRequest, CancellationToken)

Initiates the asynchronous execution of the CreateCampaign operation.

Public Method CreateImportJob(CreateImportJobRequest)

Creates or updates an import job.

Public Method CreateImportJobAsync(CreateImportJobRequest, CancellationToken)

Initiates the asynchronous execution of the CreateImportJob operation.

Public Method CreateSegment(CreateSegmentRequest)

Used to create or update a segment.

Public Method CreateSegmentAsync(CreateSegmentRequest, CancellationToken)

Initiates the asynchronous execution of the CreateSegment operation.

Public Method DeleteAdmChannel(DeleteAdmChannelRequest)

Delete an ADM channel

Public Method DeleteAdmChannelAsync(DeleteAdmChannelRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteAdmChannel operation.

Public Method DeleteApnsChannel(DeleteApnsChannelRequest)

Deletes the APNs channel for an app.

Public Method DeleteApnsChannelAsync(DeleteApnsChannelRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteApnsChannel operation.

Public Method DeleteApnsSandboxChannel(DeleteApnsSandboxChannelRequest)

Delete an APNS sandbox channel

Public Method DeleteApnsSandboxChannelAsync(DeleteApnsSandboxChannelRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteApnsSandboxChannel operation.

Public Method DeleteApp(DeleteAppRequest)

Deletes an app.

Public Method DeleteAppAsync(DeleteAppRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteApp operation.

Public Method DeleteBaiduChannel(DeleteBaiduChannelRequest)

Delete a BAIDU GCM channel

Public Method DeleteBaiduChannelAsync(DeleteBaiduChannelRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteBaiduChannel operation.

Public Method DeleteCampaign(DeleteCampaignRequest)

Deletes a campaign.

Public Method DeleteCampaignAsync(DeleteCampaignRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteCampaign operation.

Public Method DeleteEmailChannel(DeleteEmailChannelRequest)

Delete an email channel

Public Method DeleteEmailChannelAsync(DeleteEmailChannelRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteEmailChannel operation.

Public Method DeleteEventStream(DeleteEventStreamRequest)

Deletes the event stream for an app.

Public Method DeleteEventStreamAsync(DeleteEventStreamRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteEventStream operation.

Public Method DeleteGcmChannel(DeleteGcmChannelRequest)

Deletes the GCM channel for an app.

Public Method DeleteGcmChannelAsync(DeleteGcmChannelRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteGcmChannel operation.

Public Method DeleteSegment(DeleteSegmentRequest)

Deletes a segment.

Public Method DeleteSegmentAsync(DeleteSegmentRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteSegment operation.

Public Method DeleteSmsChannel(DeleteSmsChannelRequest)

Delete an SMS channel

Public Method DeleteSmsChannelAsync(DeleteSmsChannelRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteSmsChannel operation.

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

Get an ADM channel

Public Method GetAdmChannelAsync(GetAdmChannelRequest, CancellationToken)

Initiates the asynchronous execution of the GetAdmChannel operation.

Public Method GetApnsChannel(GetApnsChannelRequest)

Returns information about the APNs channel for an app.

Public Method GetApnsChannelAsync(GetApnsChannelRequest, CancellationToken)

Initiates the asynchronous execution of the GetApnsChannel operation.

Public Method GetApnsSandboxChannel(GetApnsSandboxChannelRequest)

Get an APNS sandbox channel

Public Method GetApnsSandboxChannelAsync(GetApnsSandboxChannelRequest, CancellationToken)

Initiates the asynchronous execution of the GetApnsSandboxChannel operation.

Public Method GetApp(GetAppRequest)

Returns information about an app.

Public Method GetAppAsync(GetAppRequest, CancellationToken)

Initiates the asynchronous execution of the GetApp operation.

Public Method GetApplicationSettings(GetApplicationSettingsRequest)

Used to request the settings for an app.

Public Method GetApplicationSettingsAsync(GetApplicationSettingsRequest, CancellationToken)

Initiates the asynchronous execution of the GetApplicationSettings operation.

Public Method GetApps(GetAppsRequest)

Returns information about your apps.

Public Method GetAppsAsync(GetAppsRequest, CancellationToken)

Initiates the asynchronous execution of the GetApps operation.

Public Method GetBaiduChannel(GetBaiduChannelRequest)

Get a BAIDU GCM channel

Public Method GetBaiduChannelAsync(GetBaiduChannelRequest, CancellationToken)

Initiates the asynchronous execution of the GetBaiduChannel operation.

Public Method GetCampaign(GetCampaignRequest)

Returns information about a campaign.

Public Method GetCampaignActivities(GetCampaignActivitiesRequest)

Returns information about the activity performed by a campaign.

Public Method GetCampaignActivitiesAsync(GetCampaignActivitiesRequest, CancellationToken)

Initiates the asynchronous execution of the GetCampaignActivities operation.

Public Method GetCampaignAsync(GetCampaignRequest, CancellationToken)

Initiates the asynchronous execution of the GetCampaign operation.

Public Method GetCampaigns(GetCampaignsRequest)

Returns information about your campaigns.

Public Method GetCampaignsAsync(GetCampaignsRequest, CancellationToken)

Initiates the asynchronous execution of the GetCampaigns operation.

Public Method GetCampaignVersion(GetCampaignVersionRequest)

Returns information about a specific version of a campaign.

Public Method GetCampaignVersionAsync(GetCampaignVersionRequest, CancellationToken)

Initiates the asynchronous execution of the GetCampaignVersion operation.

Public Method GetCampaignVersions(GetCampaignVersionsRequest)

Returns information about your campaign versions.

Public Method GetCampaignVersionsAsync(GetCampaignVersionsRequest, CancellationToken)

Initiates the asynchronous execution of the GetCampaignVersions operation.

Public Method GetEmailChannel(GetEmailChannelRequest)

Get an email channel

Public Method GetEmailChannelAsync(GetEmailChannelRequest, CancellationToken)

Initiates the asynchronous execution of the GetEmailChannel operation.

Public Method GetEndpoint(GetEndpointRequest)

Returns information about an endpoint.

Public Method GetEndpointAsync(GetEndpointRequest, CancellationToken)

Initiates the asynchronous execution of the GetEndpoint operation.

Public Method GetEventStream(GetEventStreamRequest)

Returns the event stream for an app.

Public Method GetEventStreamAsync(GetEventStreamRequest, CancellationToken)

Initiates the asynchronous execution of the GetEventStream operation.

Public Method GetGcmChannel(GetGcmChannelRequest)

Returns information about the GCM channel for an app.

Public Method GetGcmChannelAsync(GetGcmChannelRequest, CancellationToken)

Initiates the asynchronous execution of the GetGcmChannel operation.

Public Method GetImportJob(GetImportJobRequest)

Returns information about an import job.

Public Method GetImportJobAsync(GetImportJobRequest, CancellationToken)

Initiates the asynchronous execution of the GetImportJob operation.

Public Method GetImportJobs(GetImportJobsRequest)

Returns information about your import jobs.

Public Method GetImportJobsAsync(GetImportJobsRequest, CancellationToken)

Initiates the asynchronous execution of the GetImportJobs operation.

Public Method GetSegment(GetSegmentRequest)

Returns information about a segment.

Public Method GetSegmentAsync(GetSegmentRequest, CancellationToken)

Initiates the asynchronous execution of the GetSegment operation.

Public Method GetSegmentImportJobs(GetSegmentImportJobsRequest)

Returns a list of import jobs for a specific segment.

Public Method GetSegmentImportJobsAsync(GetSegmentImportJobsRequest, CancellationToken)

Initiates the asynchronous execution of the GetSegmentImportJobs operation.

Public Method GetSegments(GetSegmentsRequest)

Used to get information about your segments.

Public Method GetSegmentsAsync(GetSegmentsRequest, CancellationToken)

Initiates the asynchronous execution of the GetSegments operation.

Public Method GetSegmentVersion(GetSegmentVersionRequest)

Returns information about a segment version.

Public Method GetSegmentVersionAsync(GetSegmentVersionRequest, CancellationToken)

Initiates the asynchronous execution of the GetSegmentVersion operation.

Public Method GetSegmentVersions(GetSegmentVersionsRequest)

Returns information about your segment versions.

Public Method GetSegmentVersionsAsync(GetSegmentVersionsRequest, CancellationToken)

Initiates the asynchronous execution of the GetSegmentVersions operation.

Public Method GetSmsChannel(GetSmsChannelRequest)

Get an SMS channel

Public Method GetSmsChannelAsync(GetSmsChannelRequest, CancellationToken)

Initiates the asynchronous execution of the GetSmsChannel operation.

Public Method PutEventStream(PutEventStreamRequest)

Use to create or update the event stream for an app.

Public Method PutEventStreamAsync(PutEventStreamRequest, CancellationToken)

Initiates the asynchronous execution of the PutEventStream operation.

Public Method SendMessages(SendMessagesRequest)

Send a batch of messages

Public Method SendMessagesAsync(SendMessagesRequest, CancellationToken)

Initiates the asynchronous execution of the SendMessages operation.

Public Method SendUsersMessages(SendUsersMessagesRequest)

Send a batch of messages to users

Public Method SendUsersMessagesAsync(SendUsersMessagesRequest, CancellationToken)

Initiates the asynchronous execution of the SendUsersMessages operation.

Public Method UpdateAdmChannel(UpdateAdmChannelRequest)

Update an ADM channel

Public Method UpdateAdmChannelAsync(UpdateAdmChannelRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateAdmChannel operation.

Public Method UpdateApnsChannel(UpdateApnsChannelRequest)

Use to update the APNs channel for an app.

Public Method UpdateApnsChannelAsync(UpdateApnsChannelRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateApnsChannel operation.

Public Method UpdateApnsSandboxChannel(UpdateApnsSandboxChannelRequest)

Update an APNS sandbox channel

Public Method UpdateApnsSandboxChannelAsync(UpdateApnsSandboxChannelRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateApnsSandboxChannel operation.

Public Method UpdateApplicationSettings(UpdateApplicationSettingsRequest)

Used to update the settings for an app.

Public Method UpdateApplicationSettingsAsync(UpdateApplicationSettingsRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateApplicationSettings operation.

Public Method UpdateBaiduChannel(UpdateBaiduChannelRequest)

Update a BAIDU GCM channel

Public Method UpdateBaiduChannelAsync(UpdateBaiduChannelRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateBaiduChannel operation.

Public Method UpdateCampaign(UpdateCampaignRequest)

Use to update a campaign.

Public Method UpdateCampaignAsync(UpdateCampaignRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateCampaign operation.

Public Method UpdateEmailChannel(UpdateEmailChannelRequest)

Update an email channel

Public Method UpdateEmailChannelAsync(UpdateEmailChannelRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateEmailChannel operation.

Public Method UpdateEndpoint(UpdateEndpointRequest)

Use to update an endpoint.

Public Method UpdateEndpointAsync(UpdateEndpointRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateEndpoint operation.

Public Method UpdateEndpointsBatch(UpdateEndpointsBatchRequest)

Use to update a batch of endpoints.

Public Method UpdateEndpointsBatchAsync(UpdateEndpointsBatchRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateEndpointsBatch operation.

Public Method UpdateGcmChannel(UpdateGcmChannelRequest)

Use to update the GCM channel for an app.

Public Method UpdateGcmChannelAsync(UpdateGcmChannelRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateGcmChannel operation.

Public Method UpdateSegment(UpdateSegmentRequest)

Use to update a segment.

Public Method UpdateSegmentAsync(UpdateSegmentRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateSegment operation.

Public Method UpdateSmsChannel(UpdateSmsChannelRequest)

Update an SMS channel

Public Method UpdateSmsChannelAsync(UpdateSmsChannelRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateSmsChannel operation.

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 Standard:
Supported in: 1.3

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms