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.
Provides information about the status, configuration, and other settings for a campaign.
Namespace: Amazon.Pinpoint.Model
Assembly: AWSSDK.Pinpoint.dll
Version: 3.x.y.z
public class CampaignResponse
The CampaignResponse type exposes the following members
Name | Description | |
---|---|---|
CampaignResponse() |
Name | Type | Description | |
---|---|---|---|
AdditionalTreatments | System.Collections.Generic.List<Amazon.Pinpoint.Model.TreatmentResource> |
Gets and sets the property AdditionalTreatments. An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment. |
|
ApplicationId | System.String |
Gets and sets the property ApplicationId. The unique identifier for the application that the campaign applies to. |
|
Arn | System.String |
Gets and sets the property Arn. The Amazon Resource Name (ARN) of the campaign. |
|
CreationDate | System.String |
Gets and sets the property CreationDate. The date, in ISO 8601 format, when the campaign was created. |
|
CustomDeliveryConfiguration | Amazon.Pinpoint.Model.CustomDeliveryConfiguration |
Gets and sets the property CustomDeliveryConfiguration. The delivery configuration settings for sending the campaign through a custom channel. |
|
DefaultState | Amazon.Pinpoint.Model.CampaignState |
Gets and sets the property DefaultState. The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment. |
|
Description | System.String |
Gets and sets the property Description. The custom description of the campaign. |
|
HoldoutPercent | System.Int32 |
Gets and sets the property HoldoutPercent. The allocated percentage of users (segment members) who shouldn't receive messages from the campaign. |
|
Hook | Amazon.Pinpoint.Model.CampaignHook |
Gets and sets the property Hook. The settings for the AWS Lambda function to use as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign. |
|
Id | System.String |
Gets and sets the property Id. The unique identifier for the campaign. |
|
IsPaused | System.Boolean |
Gets and sets the property IsPaused. Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false. |
|
LastModifiedDate | System.String |
Gets and sets the property LastModifiedDate. The date, in ISO 8601 format, when the campaign was last modified. |
|
Limits | Amazon.Pinpoint.Model.CampaignLimits |
Gets and sets the property Limits. The messaging limits for the campaign. |
|
MessageConfiguration | Amazon.Pinpoint.Model.MessageConfiguration |
Gets and sets the property MessageConfiguration. The message configuration settings for the campaign. |
|
Name | System.String |
Gets and sets the property Name. The name of the campaign. |
|
Priority | System.Int32 |
Gets and sets the property Priority. Defines the priority of the campaign, used to decide the order of messages displayed to user if there are multiple messages scheduled to be displayed at the same moment. |
|
Schedule | Amazon.Pinpoint.Model.Schedule |
Gets and sets the property Schedule. The schedule settings for the campaign. |
|
SegmentId | System.String |
Gets and sets the property SegmentId. The unique identifier for the segment that's associated with the campaign. |
|
SegmentVersion | System.Int32 |
Gets and sets the property SegmentVersion. The version number of the segment that's associated with the campaign. |
|
State | Amazon.Pinpoint.Model.CampaignState |
Gets and sets the property State. The current status of the campaign. |
|
Tags | System.Collections.Generic.Dictionary<System.String, System.String> |
Gets and sets the property Tags. A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value. |
|
TemplateConfiguration | Amazon.Pinpoint.Model.TemplateConfiguration |
Gets and sets the property TemplateConfiguration. The message template that’s used for the campaign. |
|
TreatmentDescription | System.String |
Gets and sets the property TreatmentDescription. The custom description of the default treatment for the campaign. |
|
TreatmentName | System.String |
Gets and sets the property TreatmentName. The custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing. |
|
Version | System.Int32 |
Gets and sets the property Version. The version number of the campaign. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5