CampaignResponse

public struct CampaignResponse : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

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

    Declaration

    Swift

    public let additionalTreatments: [TreatmentResource]?

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

    Declaration

    Swift

    public let applicationId: String
  • arn

    The Amazon Resource Name (ARN) of the campaign.

    Declaration

    Swift

    public let arn: String

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

    Declaration

    Swift

    public let creationDate: String

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

    Declaration

    Swift

    public let customDeliveryConfiguration: CustomDeliveryConfiguration?

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

    Declaration

    Swift

    public let defaultState: CampaignState?

  • The 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 use 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?
  • id

    The unique identifier for the campaign.

    Declaration

    Swift

    public let id: String

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

    Declaration

    Swift

    public let isPaused: Bool?

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

    Declaration

    Swift

    public let lastModifiedDate: String

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

  • The name of 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 that’s associated with the campaign.

    Declaration

    Swift

    public let segmentId: String

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

    Declaration

    Swift

    public let segmentVersion: Int

  • The current status of the campaign.

    Declaration

    Swift

    public let state: CampaignState?

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

    Declaration

    Swift

    public let tags: [String : String]?

  • The message template that’s used for the campaign.

    Declaration

    Swift

    public let templateConfiguration: TemplateConfiguration?

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

    Declaration

    Swift

    public let treatmentDescription: String?

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

    Declaration

    Swift

    public let treatmentName: String?

  • The version number of the campaign.

    Declaration

    Swift

    public let version: Int?

  • Undocumented

    Declaration

    Swift

    public init(additionalTreatments: [TreatmentResource]? = nil, applicationId: String, arn: String, creationDate: String, customDeliveryConfiguration: CustomDeliveryConfiguration? = nil, defaultState: CampaignState? = nil, description: String? = nil, holdoutPercent: Int? = nil, hook: CampaignHook? = nil, id: String, isPaused: Bool? = nil, lastModifiedDate: String, limits: CampaignLimits? = nil, messageConfiguration: MessageConfiguration? = nil, name: String? = nil, schedule: Schedule? = nil, segmentId: String, segmentVersion: Int, state: CampaignState? = nil, tags: [String : String]? = nil, templateConfiguration: TemplateConfiguration? = nil, treatmentDescription: String? = nil, treatmentName: String? = nil, version: Int? = nil)