CampaignResponse ¶

class CampaignResponse(TypedDict, closed=True):
    additional_treatments: NotRequired[
        "capo_pinpoint.types.list_of_treatment_resource.ListOfTreatmentResource"
    ]
    """<p>An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.</p>"""
    application_id: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The unique identifier for the application that the campaign applies to.</p>"""
    arn: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The Amazon Resource Name (ARN) of the campaign.</p>"""
    creation_date: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The date, in ISO 8601 format, when the campaign was created.</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.</p>"""
    default_state: NotRequired["capo_pinpoint.types.campaign_state.CampaignState"]
    """<p>The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment.</p>"""
    description: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The 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 use as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.</p>"""
    id: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The unique identifier for the campaign.</p>"""
    is_paused: NotRequired["capo_pinpoint.types.__boolean.__boolean"]
    """<p>Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.</p>"""
    last_modified_date: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The date, in ISO 8601 format, when the campaign was last modified.</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>The name of 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 that's associated with the campaign.</p>"""
    segment_version: NotRequired["capo_pinpoint.types.__integer.__integer"]
    """<p>The version number of the segment that's associated with the campaign.</p>"""
    state: NotRequired["capo_pinpoint.types.campaign_state.CampaignState"]
    """<p>The current status of the campaign.</p>"""
    tags: NotRequired["capo_pinpoint.types.map_of__string.MapOf__string"]
    """<p>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.</p>"""
    template_configuration: NotRequired[
        "capo_pinpoint.types.template_configuration.TemplateConfiguration"
    ]
    """<p>The message template that’s used for the campaign.</p>"""
    treatment_description: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The custom description of the default treatment for the campaign.</p>"""
    treatment_name: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The 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>"""
    version: NotRequired["capo_pinpoint.types.__integer.__integer"]
    """<p>The version number of the campaign.</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>"""