Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

WriteCampaignRequest

import type { WriteCampaignRequest } from "https://aws-api.deno.dev/v0.4/services/pinpoint.ts?docs=full";

Specifies the configuration and other settings for a campaign.

interface WriteCampaignRequest {
AdditionalTreatments?: WriteTreatmentResource[] | null;
CustomDeliveryConfiguration?: CustomDeliveryConfiguration | null;
Description?: string | null;
HoldoutPercent?: number | null;
Hook?: CampaignHook | null;
IsPaused?: boolean | null;
Limits?: CampaignLimits | null;
MessageConfiguration?: MessageConfiguration | null;
Name?: string | null;
Priority?: number | null;
Schedule?: Schedule | null;
SegmentId?: string | null;
SegmentVersion?: number | null;
tags?: {
[key: string]: string | null | undefined;
}
| null;
TemplateConfiguration?: TemplateConfiguration | null;
TreatmentDescription?: string | null;
TreatmentName?: string | null;
}

§Properties

§
AdditionalTreatments?: WriteTreatmentResource[] | null
[src]

An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.

§
CustomDeliveryConfiguration?: CustomDeliveryConfiguration | null
[src]

The delivery configuration settings for sending the campaign through a custom channel. This object is required if the MessageConfiguration object for the campaign specifies a CustomMessage object.

§
Description?: string | null
[src]

A custom description of the campaign.

§
HoldoutPercent?: number | null
[src]

The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.

§
Hook?: CampaignHook | null
[src]

The settings for the AWS Lambda function to invoke as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.

§
IsPaused?: boolean | null
[src]

Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing this value to false.

§
Limits?: CampaignLimits | null
[src]

The messaging limits for the campaign.

§
MessageConfiguration?: MessageConfiguration | null
[src]

The message configuration settings for the campaign.

§
Name?: string | null
[src]

A custom name for the campaign.

§
Priority?: number | null
[src]

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?: Schedule | null
[src]

The schedule settings for the campaign.

§
SegmentId?: string | null
[src]

The unique identifier for the segment to associate with the campaign.

§
SegmentVersion?: number | null
[src]

The version of the segment to associate with the campaign.

§
tags?: {
[key: string]: string | null | undefined;
}
| null
[src]

A string-to-string map of key-value pairs that defines the tags to associate with the campaign. Each tag consists of a required tag key and an associated tag value.

§
TemplateConfiguration?: TemplateConfiguration | null
[src]

The message template to use for the campaign.

§
TreatmentDescription?: string | null
[src]

A custom description of the default treatment for the campaign.

§
TreatmentName?: string | null
[src]

A 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.