Configuration information related to the configuration of a button with settings that are specific to a certain device type.
ButtonAction
The action that occurs when a recipient chooses a button in an in-app message. You can specify one of the following:
• LINK – A link to a web destination.
• DEEP_LINK – A link to a specific page in an application.
• CLOSE – Dismisses the message.
Type: string Required: True
Values: LINK | DEEP_LINK | CLOSE
Link
The destination (such as a URL) for a button.
Type: string Required: False
QuietTime
Specifies the start and end times that define a time range when messages aren't sent to endpoints.
Start
The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Type: string Required: False
End
The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
Properties
Type: string Required: False
Schedule
Specifies the schedule settings for a campaign.
StartTime
The scheduled time when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.
Type: string Required: True
EndTime
The scheduled time, in ISO 8601 format, when the campaign ended or will end.
Type: string Required: False
Frequency
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
Type: string Required: False
Values: ONCE | HOURLY | DAILY | WEEKLY | MONTHLY | EVENT | IN_APP_EVENT
IsLocalTime
Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
Type: boolean Required: False
Timezone
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true.
Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC +10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.
Type: string Required: False
QuietTime
The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
Properties
• The EndpointDemographic.Timezone property of the endpoint is set to a valid value.
• The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.
• The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.
If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
Type: QuietTime (p. 130) Required: False
EventFilter
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
Type: CampaignEventFilter (p. 114) Required: False
SetDimension
Specifies the dimension type and values for a segment dimension.
DimensionType
The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
Type: string Required: False
Values: INCLUSIVE | EXCLUSIVE
Values
The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
Type: Array of type string Required: True
Template
Specifies the name and version of the message template to use for the message.
Name
The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
Type: string Required: False
Properties
Version
The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions (p. 740) resource.
If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template.
The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
Type: string Required: False
TemplateConfiguration
Specifies the message template to use for the message, for each type of channel.
SMSTemplate
The SMS template to use for the message.
Type: Template (p. 132) Required: False
EmailTemplate
The email template to use for the message.
Type: Template (p. 132) Required: False
PushTemplate
The push notification template to use for the message.
Type: Template (p. 132) Required: False
VoiceTemplate
The voice template to use for the message. This object isn't supported for campaigns.
Type: Template (p. 132) Required: False
TreatmentResource
Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
TreatmentName
The custom name of the treatment.
Type: string Required: False
Properties
TreatmentDescription
The custom description of the treatment.
Type: string Required: False
MessageConfiguration
The message configuration settings for the treatment.
Type: MessageConfiguration (p. 128) Required: False
Schedule
The schedule settings for the treatment.
Type: Schedule (p. 131) Required: False
TemplateConfiguration
The message template to use for the treatment.
Type: TemplateConfiguration (p. 133) Required: False
CustomDeliveryConfiguration
The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.
Type: CustomDeliveryConfiguration (p. 121) Required: False
SizePercent
The allocated percentage of users (segment members) that the treatment is sent to.
Type: integer Required: True
Id
The unique identifier for the treatment.
Type: string Required: True
State
The current status of the treatment.
Type: CampaignState (p. 121)
Properties
Required: False
WriteCampaignRequest
Specifies the configuration and other settings for a campaign.
TreatmentName
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.
Type: string Required: False
TreatmentDescription
A custom description of the default treatment for the campaign.
Type: string Required: False
MessageConfiguration
The message configuration settings for the campaign.
Type: MessageConfiguration (p. 128) Required: False
Schedule
The schedule settings for the campaign.
Type: Schedule (p. 131) Required: False
TemplateConfiguration
The message template to use for the campaign.
Type: TemplateConfiguration (p. 133) Required: False
CustomDeliveryConfiguration
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.
Type: CustomDeliveryConfiguration (p. 121) Required: False
SegmentId
The unique identifier for the segment to associate with the campaign.
Type: string
Properties
Required: False
SegmentVersion
The version of the segment to associate with the campaign.
Type: integer Required: False
IsPaused
Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing this value to false. If you restart a campaign, the campaign restarts from the beginning and not at the point you paused it.
Type: boolean Required: False
AdditionalTreatments
An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
Type: Array of type WriteTreatmentResource (p. 137) Required: False
HoldoutPercent
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
Type: integer Required: False
Limits
The messaging limits for the campaign.
Type: CampaignLimits (p. 115) Required: False
Name
A custom name for the campaign.
Type: string Required: False
Hook
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.
Type: CampaignHook (p. 114) Required: False
Properties
Description
A custom description of the campaign.
Type: string Required: False
tags
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.
Type: object Required: False
Priority
An integer between 1 and 5, inclusive, that represents the priority of the in-app message campaign, where 1 is the highest priority and 5 is the lowest. If there are multiple messages scheduled to be displayed at the same time, the priority determines the order in which those messages are displayed.
Type: integer Required: False
WriteTreatmentResource
Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
TreatmentName
A custom name for the treatment.
Type: string Required: False
TreatmentDescription
A custom description of the treatment.
Type: string Required: False
MessageConfiguration
The message configuration settings for the treatment.
Type: MessageConfiguration (p. 128) Required: False
Schedule
The schedule settings for the treatment.
Type: Schedule (p. 131)
See also
Required: False
TemplateConfiguration
The message template to use for the treatment.
Type: TemplateConfiguration (p. 133) Required: False
CustomDeliveryConfiguration
The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.
Type: CustomDeliveryConfiguration (p. 121) Required: False
SizePercent
The allocated percentage of users (segment members) to send the treatment to.
Type: integer Required: True
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following:
GetCampaign
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
UpdateCampaign
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript