WriteCampaignRequest ¶

class WriteCampaignRequest(TypedDict, closed=True):
    additional_treatments: NotRequired[
        "capo_pinpoint.types.list_of_write_treatment_resource.ListOfWriteTreatmentResource"
    ]
    """<p>An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.</p>"""
    custom_delivery_configuration: NotRequired[
        "capo_pinpoint.types.custom_delivery_configuration.CustomDeliveryConfiguration"
    ]
    """<p>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.</p>"""
    description: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>A custom description of the campaign.</p>"""
    holdout_percent: NotRequired["capo_pinpoint.types.__integer.__integer"]
    """<p>The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.</p>"""
    hook: NotRequired["capo_pinpoint.types.campaign_hook.CampaignHook"]
    """<p>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.</p>"""
    is_paused: NotRequired["capo_pinpoint.types.__boolean.__boolean"]
    """<p>Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing this value to false.</p>"""
    limits: NotRequired["capo_pinpoint.types.campaign_limits.CampaignLimits"]
    """<p>The messaging limits for the campaign.</p>"""
    message_configuration: NotRequired[
        "capo_pinpoint.types.message_configuration.MessageConfiguration"
    ]
    """<p>The message configuration settings for the campaign.</p>"""
    name: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>A custom name for the campaign.</p>"""
    schedule: NotRequired["capo_pinpoint.types.schedule.Schedule"]
    """<p>The schedule settings for the campaign.</p>"""
    segment_id: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The unique identifier for the segment to associate with the campaign.</p>"""
    segment_version: NotRequired["capo_pinpoint.types.__integer.__integer"]
    """<p>The version of the segment to associate with the campaign.</p>"""
    tags: NotRequired["capo_pinpoint.types.map_of__string.MapOf__string"]
    """<note><p>As of <b>22-05-2023</b> tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either <a href="https://docs.aws.amazon.com/pinpoint/latest/apireference/tags-resource-arn.html">Tags</a> in the <i>API Reference for Amazon Pinpoint</i>, <a href="https://docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/index.html">resourcegroupstaggingapi</a> commands in the <i>AWS Command Line Interface Documentation</i> or <a href="https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/resourcegroupstaggingapi/package-summary.html">resourcegroupstaggingapi</a> in the <i>AWS SDK</i>.</p></note> <p>(Deprecated) 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.</p>"""
    template_configuration: NotRequired[
        "capo_pinpoint.types.template_configuration.TemplateConfiguration"
    ]
    """<p>The message template to use for the campaign.</p>"""
    treatment_description: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>A custom description of the default treatment for the campaign.</p>"""
    treatment_name: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>A custom name of the default treatment for the campaign, if the campaign has multiple treatments. A <i>treatment</i> is a variation of a campaign that's used for A/B testing.</p>"""
    priority: NotRequired["capo_pinpoint.types.__integer.__integer"]
    """<p>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.</p>"""