Campaign

The unique identifier for the campaign.

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Indicates which content types, expressed as MIME types, the client understands.

The request succeeded.

The request contains a syntax error (BadRequestException).

The request was denied because access to the specified resource is forbidden (ForbiddenException).

The request failed because the specified resource was not found (NotFoundException).

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

The unique identifier for the campaign.

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Indicates which content types, expressed as MIME types, the client understands.

The request succeeded.

The request contains a syntax error (BadRequestException).

The request was denied because access to the specified resource is forbidden (ForbiddenException).

The request failed because the specified resource was not found (NotFoundException).

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

The unique identifier for the campaign.

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Indicates which content types, expressed as MIME types, the client understands.

The request succeeded.

The request contains a syntax error (BadRequestException).

The request was denied because access to the specified resource is forbidden (ForbiddenException).

The request failed because the specified resource was not found (NotFoundException).

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

The unique identifier for the campaign.

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

The request succeeded.

string

Values: INCLUSIVE | EXCLUSIVE | CONTAINS | BEFORE | AFTER | BETWEEN | NOT_BETWEEN | ON

The type of segment dimension to use. Valid values are:

Array of type string

The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

string

The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.

string

The body of the email for recipients whose email clients don't render HTML content.

string

The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.

Array of type MessageHeader

The list of MessageHeaders for the email. You can have up to 15 MessageHeaders for each email.

string

The body of the email, in HTML format, for recipients whose email clients render HTML content.

string

The subject line, or title, of the email.

EventDimensions

The dimension settings of the event filter for the campaign.

string

Values: SYSTEM | ENDPOINT | USER

The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Events resource) occurs.

string

The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.

string

Values: DELIVERY | FILTER

The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are:

string

The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.

string

The body text of the in-app notification.

Array of type InAppMessageContent

An array that contains configurtion information about the in-app message for the campaign, including title and body text, text colors, background colors, image URLs, and button configurations.

object

An object that contains custom data (in the form of key-value pairs) that is included in the in-app messaging payload.

string

Values: BOTTOM_BANNER | TOP_BANNER | OVERLAYS | MOBILE_FEED | MIDDLE_BANNER | CAROUSEL

A string that describes how the in-app message will appear. You can specify one of the following:

integer

The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. For an application, this value specifies the default limit for the number of messages that campaigns and journeys can send to a single endpoint during a 24-hour period. The maximum value is 100.

integer

The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.

integer

The maximum number of messages that a campaign can send each second. For an application, this value specifies the default limit for the number of messages that campaigns can send each second. The minimum value is 1. The maximum value is 20,000.

integer

The maximum number of messages that the campaign can send per user session.

integer

The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. If a campaign recurs, this setting applies to all runs of the campaign. The maximum value is 100.

Array of type TreatmentResource

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

string

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

string

The Amazon Resource Name (ARN) of the campaign.

string

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

CustomDeliveryConfiguration

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

CampaignState

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

string

The custom description of the campaign.

integer

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

CampaignHook

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.

string

The unique identifier for the campaign.

boolean

Specifies whether the campaign is paused. 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.

string

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

CampaignLimits

The messaging limits for the campaign.

MessageConfiguration

The message configuration settings for the campaign.

string

The name of the campaign.

integer

Defines the priority of the campaign. This value used to determine the order in which messages are displayed to the recipient if there are multiple messages scheduled to be displayed at the same time.

Schedule

The schedule settings for the campaign.

string

The unique identifier for the segment that's associated with the campaign.

integer

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

CampaignState

The current status of the campaign.

object

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.

TemplateConfiguration

The message template that’s used for the campaign.

string

The custom description of the default treatment for the campaign.

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.

integer

The version number of the campaign.

string

The body of the SMS message.

string

A registered Entity ID (currently only used when sending messages to recipients in India).

string

Values: TRANSACTIONAL | PROMOTIONAL

The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).

string

The number to send the SMS message from. The phone number that you specify must exist in your Amazon Pinpoint account—you can't pass an arbitrary phone number. If you want to use a sender ID to send your message, omit this parameter and use SenderId instead.

string

The alphabetic Sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region. To specify a phone number as the sender, omit this parameter and use OriginationNumber instead. For more information about support for Sender ID by country, see the Amazon Pinpoint User Guide.

string

A registered Template ID (currently only used when sending messages to recipients in India).

string

Values: SCHEDULED | EXECUTING | PENDING_NEXT_RUN | COMPLETED | PAUSED | DELETED | INVALID | PENDING_APPROVAL | DRAFT

The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.

If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.

string

The destination to send the campaign or treatment to. This value can be one of the following:

Array of type string

Values: PUSH | GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | VOICE | EMAIL | BAIDU | CUSTOM | IN_APP

The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.

string

The background color of a button, expressed as a string consisting of a hex color code (such as "#000000" for black).

integer

The border radius of a button.

string

Values: LINK | DEEP_LINK | CLOSE

The action that occurs when a recipient chooses a button in an in-app message. You can specify one of the following:

string

The destination (such as a URL) for a button.

string

The text that appears on a button in an in-app message.

string

The color of the body text in a button, expressed as a string consisting of a hex color code (such as "#000000" for black).

object

One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.

SetDimension

The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered or _custom.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide.

object

One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.

string

Values: LEFT | CENTER | RIGHT

The text alignment of the main body text of the message.

string

The main body text of the message.

string

The color of the body text, expressed as a string consisting of a hex color code (such as "#000000" for black).

OverrideButtonConfiguration

An object that defines the default behavior for a button in in-app messages sent to Android.

DefaultButtonConfiguration

An object that defines the default behavior for a button in an in-app message.

OverrideButtonConfiguration

An object that defines the default behavior for a button in in-app messages sent to iOS devices.

OverrideButtonConfiguration

An object that defines the default behavior for a button in in-app messages for web applications.

string

The background color for an in-app message banner, expressed as a string consisting of a hex color code (such as "#000000" for black).

InAppMessageBodyConfig

An object that contains configuration information about the header or title text of the in-app message.

InAppMessageHeaderConfig

An object that contains configuration information about the header or title text of the in-app message.

string

The URL of the image that appears on an in-app message banner.

InAppMessageButton

An object that contains configuration information about the primary button in an in-app message.

InAppMessageButton

An object that contains configuration information about the secondary button in an in-app message.

string

Values: LEFT | CENTER | RIGHT

The text alignment of the title of the message.

string

The text that appears in the header or title of the message.

string

The color of the body text, expressed as a string consisting of a hex color code (such as "#000000" for black).

string

Values: OPEN_APP | DEEP_LINK | URL

The action to occur if a recipient taps the push notification. Valid values are:

string

The body of the notification message. The maximum number of characters is 200.

string

The URL of the image to display as the push notification icon, such as the icon for the app.

string

The URL of the image to display as the small, push notification icon, such as a small version of the icon for the app.

string

The URL of an image to display in the push notification.

string

The JSON payload to use for a silent push notification.

string

The URL of the image or video to display in the push notification.

string

The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

boolean

Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

integer

The number of seconds that the push notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

string

The title to display above the notification message on a recipient's device.

string

The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

string

The message that's returned from the API.

string

The unique identifier for the request or response.

Message

The message that the campaign sends through the ADM (Amazon Device Messaging) channel. If specified, this message overrides the default message.

Message

The message that the campaign sends through the APNs (Apple Push Notification service) channel. If specified, this message overrides the default message.

Message

The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. If specified, this message overrides the default message.

CampaignCustomMessage

The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.

Message

The default message that the campaign sends through all the channels that are configured for the campaign.

CampaignEmailMessage

The message that the campaign sends through the email channel. If specified, this message overrides the default message.

Message

The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this message overrides the default message.

CampaignInAppMessage

The default message for the in-app messaging channel. This message overrides the default message (DefaultMessage).

CampaignSmsMessage

The message that the campaign sends through the SMS channel. If specified, this message overrides the default message.

string

The name of the message header. The header name can contain up to 126 characters.

string

The value of the message header. The header value can contain up to 870 characters, including the length of any rendered attributes. For example if you add the {CreationDate} attribute, it renders as YYYY-MM-DDTHH:MM:SS.SSSZ and is 24 characters in length.

string

The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.

number

The value to compare.

string

Values: LINK | DEEP_LINK | CLOSE

The action that occurs when a recipient chooses a button in an in-app message. You can specify one of the following:

string

The destination (such as a URL) for a button.

string

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.

string

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.

string

The scheduled time, in ISO 8601 format, when the campaign ended or will end.

CampaignEventFilter

The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.

string

Values: ONCE | HOURLY | DAILY | WEEKLY | MONTHLY | EVENT | IN_APP_EVENT

Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.

boolean

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.

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:

If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.

string

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.

string

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.

string

Values: INCLUSIVE | EXCLUSIVE

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.

Array of type string

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.

string

The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

string

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

Template

The email template to use for the message.

Template

The InApp template to use for the message. The InApp template object is not supported for SendMessages.

Template

The push notification template to use for the message.

Template

The SMS template to use for the message.

Template

The voice template to use for the message. This object isn't supported for campaigns.

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.

string

The unique identifier for the treatment.

MessageConfiguration

The message configuration settings for the treatment.

Schedule

The schedule settings for the treatment.

integer

The allocated percentage of users (segment members) that the treatment is sent to.

CampaignState

The current status of the treatment.

TemplateConfiguration

The message template to use for the treatment.

string

The custom description of the treatment.

string

The custom name of the treatment.

Array of type WriteTreatmentResource

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

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.

string

A custom description of the campaign.

integer

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

CampaignHook

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.

boolean

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. If a campaign is running it will complete and then pause. Pause only pauses or skips the next run for a recurring future scheduled campaign. A campaign scheduled for immediate can't be paused.

CampaignLimits

The messaging limits for the campaign.

MessageConfiguration

The message configuration settings for the campaign.

string

A custom name for the campaign.

integer

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.

Schedule

The schedule settings for the campaign.

string

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

integer

The version of the segment to associate with the campaign.

object

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

TemplateConfiguration

The message template to use for the campaign.

string

A custom description of the default treatment for the campaign.

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.

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.

MessageConfiguration

The message configuration settings for the treatment.

Schedule

The schedule settings for the treatment.

integer

The allocated percentage of users (segment members) to send the treatment to.

TemplateConfiguration

The message template to use for the treatment.

string

A custom description of the treatment.

string

A custom name for the treatment.