CampaignResponse

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

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

interface CampaignResponse {

AdditionalTreatments?: TreatmentResource[] | null;

ApplicationId: string;

Arn: string;

CreationDate: string;

CustomDeliveryConfiguration?: CustomDeliveryConfiguration | null;

DefaultState?: CampaignState | null;

Description?: string | null;

HoldoutPercent?: number | null;

Hook?: CampaignHook | null;

Id: string;

IsPaused?: boolean | null;

LastModifiedDate: string;

Limits?: CampaignLimits | null;

MessageConfiguration?: MessageConfiguration | null;

Name?: string | null;

Priority?: number | null;

Schedule?: Schedule | null;

SegmentId: string;

SegmentVersion: number;

State?: CampaignState | null;

tags?: {

[key: string]: string | null | undefined;

} | null;

TemplateConfiguration?: TemplateConfiguration | null;

TreatmentDescription?: string | null;

TreatmentName?: string | null;

Version?: number | null;

}

§Properties

AdditionalTreatments?: TreatmentResource[] | null

[src]

An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.

ApplicationId: string

[src]

The unique identifier for the application that the campaign applies to.

Arn: string

[src]

The Amazon Resource Name (ARN) of the campaign.

CreationDate: string

[src]

The date, in ISO 8601 format, when the campaign was created.

CustomDeliveryConfiguration?: CustomDeliveryConfiguration | null

[src]

The delivery configuration settings for sending the campaign through a custom channel.

DefaultState?: CampaignState | null

[src]

The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment.

Description?: string | null

[src]

The 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 use as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.

Id: string

[src]

The unique identifier for the campaign.

IsPaused?: boolean | null

[src]

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

LastModifiedDate: string

[src]

The date, in ISO 8601 format, when the campaign was last modified.

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]

The name of 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

[src]

The unique identifier for the segment that's associated with the campaign.

SegmentVersion: number

[src]

The version number of the segment that's associated with the campaign.

State?: CampaignState | null

[src]

The current status of the campaign.

tags?: {

[key: string]: string | null | undefined;

} | null

[src]

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?: TemplateConfiguration | null

[src]

The message template that’s used for the campaign.

TreatmentDescription?: string | null

[src]

The custom description of the default treatment for the campaign.

TreatmentName?: string | null

[src]

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?: number | null

[src]

The version number of the campaign.