WriteCampaignRequest

public struct WriteCampaignRequest : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

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

    Declaration

    Swift

    public let additionalTreatments: [WriteTreatmentResource]?

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

    Declaration

    Swift

    public let customDeliveryConfiguration: CustomDeliveryConfiguration?

  • A custom description of the campaign.

    Declaration

    Swift

    public let description: String?

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

    Declaration

    Swift

    public let holdoutPercent: Int?

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

    Declaration

    Swift

    public let hook: CampaignHook?

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

    Declaration

    Swift

    public let isPaused: Bool?

  • The messaging limits for the campaign.

    Declaration

    Swift

    public let limits: CampaignLimits?

  • The message configuration settings for the campaign.

    Declaration

    Swift

    public let messageConfiguration: MessageConfiguration?

  • A custom name for the campaign.

    Declaration

    Swift

    public let name: String?

  • The schedule settings for the campaign.

    Declaration

    Swift

    public let schedule: Schedule?

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

    Declaration

    Swift

    public let segmentId: String?

  • The version of the segment to associate with the campaign.

    Declaration

    Swift

    public let segmentVersion: Int?

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

    Declaration

    Swift

    public let tags: [String : String]?

  • The message template to use for the campaign.

    Declaration

    Swift

    public let templateConfiguration: TemplateConfiguration?

  • A custom description of the default treatment for the campaign.

    Declaration

    Swift

    public let treatmentDescription: String?

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

    Declaration

    Swift

    public let treatmentName: String?

  • Undocumented

    Declaration

    Swift

    public init(additionalTreatments: [WriteTreatmentResource]? = nil, customDeliveryConfiguration: CustomDeliveryConfiguration? = nil, description: String? = nil, holdoutPercent: Int? = nil, hook: CampaignHook? = nil, isPaused: Bool? = nil, limits: CampaignLimits? = nil, messageConfiguration: MessageConfiguration? = nil, name: String? = nil, schedule: Schedule? = nil, segmentId: String? = nil, segmentVersion: Int? = nil, tags: [String : String]? = nil, templateConfiguration: TemplateConfiguration? = nil, treatmentDescription: String? = nil, treatmentName: String? = nil)