Campaign Version

Provides information about a specific campaign version.

URI

/v1/apps/application-id/campaigns/campaign-id/versions/version

HTTP Methods

GET

Returns information about a specific version of a campaign.

Header

Name	Required	Type
accept	false	string

Path

Name	Required	Type
application-id	true	string
campaign-id	true	string
version	true	string

Response

Status Code	Schema
200	CampaignResponse

Errors

Errors

Status Code	Schema	Error Type
400	MessageBody	BadRequestException
403	MessageBody	ForbiddenException
404	MessageBody	NotFoundException
405	MessageBody	MethodNotAllowedException
429	MessageBody	TooManyRequestsException
500	MessageBody	InternalServerErrorException

Schemas

Response Schemas

Example CampaignResponse


{
    "TreatmentName": "string",
    "TreatmentDescription": "string",
    "MessageConfiguration": {
        "DefaultMessage": {
            "Title": "string",
            "Body": "string",
            "ImageUrl": "string",
            "ImageIconUrl": "string",
            "ImageSmallIconUrl": "string",
            "MediaUrl": "string",
            "Action": "OPEN_APP",
            "Url": "string",
            "SilentPush": true,
            "JsonBody": "string",
            "RawContent": "string",
            "TimeToLive": 0
        },
        "APNSMessage": {
            "Title": "string",
            "Body": "string",
            "ImageUrl": "string",
            "ImageIconUrl": "string",
            "ImageSmallIconUrl": "string",
            "MediaUrl": "string",
            "Action": "OPEN_APP",
            "Url": "string",
            "SilentPush": true,
            "JsonBody": "string",
            "RawContent": "string",
            "TimeToLive": 0
        },
        "GCMMessage": {
            "Title": "string",
            "Body": "string",
            "ImageUrl": "string",
            "ImageIconUrl": "string",
            "ImageSmallIconUrl": "string",
            "MediaUrl": "string",
            "Action": "OPEN_APP",
            "Url": "string",
            "SilentPush": true,
            "JsonBody": "string",
            "RawContent": "string",
            "TimeToLive": 0
        },
        "ADMMessage": {
            "Title": "string",
            "Body": "string",
            "ImageUrl": "string",
            "ImageIconUrl": "string",
            "ImageSmallIconUrl": "string",
            "MediaUrl": "string",
            "Action": "OPEN_APP",
            "Url": "string",
            "SilentPush": true,
            "JsonBody": "string",
            "RawContent": "string",
            "TimeToLive": 0
        },
        "BaiduMessage": {
            "Title": "string",
            "Body": "string",
            "ImageUrl": "string",
            "ImageIconUrl": "string",
            "ImageSmallIconUrl": "string",
            "MediaUrl": "string",
            "Action": "OPEN_APP",
            "Url": "string",
            "SilentPush": true,
            "JsonBody": "string",
            "RawContent": "string",
            "TimeToLive": 0
        },
        "EmailMessage": {
            "Title": "string",
            "Body": "string",
            "HtmlBody": "string",
            "FromAddress": "string"
        },
        "SMSMessage": {
            "Body": "string",
            "MessageType": "TRANSACTIONAL",
            "SenderId": "string"
        }
    },
    "Schedule": {
        "StartTime": "string",
        "EndTime": "string",
        "Frequency": "ONCE",
        "IsLocalTime": true,
        "Timezone": "string",
        "QuietTime": {
            "Start": "string",
            "End": "string"
        },
        "EventFilter": {
            "Dimensions": {
                "Attributes": {
                    "attributeKey1": ["string"]
                },
                "Metrics": {"metricName": 0},
                "EventType": {
                    "DimensionType": "INCLUSIVE",
                    "Values": ["_monetization.purchase"]
                }
            },
            "FilterType": "ENDPOINT"
        }
    },
    "Id": "string",
    "ApplicationId": "string",
    "CreationDate": "string",
    "LastModifiedDate": "string",
    "SegmentId": "string",
    "SegmentVersion": 0,
    "AdditionalTreatments": [
        {
            "TreatmentName": "string",
            "TreatmentDescription": "string",
            "MessageConfiguration": {
                "DefaultMessage": {
                    "Title": "string",
                    "Body": "string",
                    "ImageUrl": "string",
                    "ImageIconUrl": "string",
                    "ImageSmallIconUrl": "string",
                    "MediaUrl": "string",
                    "Action": "OPEN_APP",
                    "Url": "string",
                    "SilentPush": true,
                    "JsonBody": "string",
                    "RawContent": "string",
                    "TimeToLive": 0
                },
                "APNSMessage": {
                    "Title": "string",
                    "Body": "string",
                    "ImageUrl": "string",
                    "ImageIconUrl": "string",
                    "ImageSmallIconUrl": "string",
                    "MediaUrl": "string",
                    "Action": "OPEN_APP",
                    "Url": "string",
                    "SilentPush": true,
                    "JsonBody": "string",
                    "RawContent": "string",
                    "TimeToLive": 0
                },
                "GCMMessage": {
                    "Title": "string",
                    "Body": "string",
                    "ImageUrl": "string",
                    "ImageIconUrl": "string",
                    "ImageSmallIconUrl": "string",
                    "MediaUrl": "string",
                    "Action": "OPEN_APP",
                    "Url": "string",
                    "SilentPush": true,
                    "JsonBody": "string",
                    "RawContent": "string",
                    "TimeToLive": 0
                },
                "ADMMessage": {
                    "Title": "string",
                    "Body": "string",
                    "ImageUrl": "string",
                    "ImageIconUrl": "string",
                    "ImageSmallIconUrl": "string",
                    "MediaUrl": "string",
                    "Action": "OPEN_APP",
                    "Url": "string",
                    "SilentPush": true,
                    "JsonBody": "string",
                    "RawContent": "string",
                    "TimeToLive": 0
                },
                "BaiduMessage": {
                    "Title": "string",
                    "Body": "string",
                    "ImageUrl": "string",
                    "ImageIconUrl": "string",
                    "ImageSmallIconUrl": "string",
                    "MediaUrl": "string",
                    "Action": "OPEN_APP",
                    "Url": "string",
                    "SilentPush": true,
                    "JsonBody": "string",
                    "RawContent": "string",
                    "TimeToLive": 0
                },
                "EmailMessage": {
                    "Title": "string",
                    "Body": "string",
                    "HtmlBody": "string",
                    "FromAddress": "string"
                },
                "SMSMessage": {
                    "Body": "string",
                    "MessageType": "TRANSACTIONAL",
                    "SenderId": "string"
                }
            },
            "Schedule": {
                "StartTime": "string",
                "EndTime": "string",
                "Frequency": "ONCE",
                "IsLocalTime": true,
                "Timezone": "string",
                "QuietTime": {
                    "Start": "string",
                    "End": "string"
                },
                "EventFilter": {
                    "Dimensions": {
                        "Attributes": {
                            "attributeKey1": ["string"]
                        },
                        "Metrics": {"metricName": 0},
                        "EventType": {
                            "DimensionType": "INCLUSIVE",
                            "Values": ["_monetization.purchase"]
                        }
                    },
                    "FilterType": "ENDPOINT"
                }
            },
            "SizePercent": 0,
            "Id": "string",
            "State": {"CampaignStatus": "SCHEDULED"}
        }
    ],
    "HoldoutPercent": 0,
    "Name": "string",
    "Limits": {
        "Daily": 0,
        "Total": 0,
        "MessagesPerSecond": 0,
        "MaximumDuration": 0
    },
    "Description": "string",
    "tags": {
        "string": "string"
    },
    "Hook": {
        "LambdaFunctionName": "string",
        "WebUrl": "string",
        "Mode": "DELIVERY"
    },
    "State": {"CampaignStatus": "SCHEDULED"},
    "DefaultState": {"CampaignStatus": "SCHEDULED"},
    "Version": 0,
    "IsPaused": true
}

Example MessageBody


{
  "RequestID": "string",
  "Message": "string"
}

Attributes

CampaignResponse

Attribute	Type	Description
AdditionalTreatments	array	Treatments that are defined in addition to the default treatment.
ApplicationId	string	The ID of the application to which the campaign applies.
Arn	string	The Amazon Resource Name (ARN) of the campaign.
CreationDate	string	The date when the campaign was created, in ISO 8601 format.
DefaultState	CampaignState	The status of the campaign's default treatment. Only present for A/B test campaigns.
Description	string	A description of the campaign.
HoldoutPercent	integer	The allocated percentage of end users who will not receive messages from this campaign.
Hook	CampaignHook	Campaign hook information.
Id	string	The unique campaign ID.
IsPaused	boolean	Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.
LastModifiedDate	string	The date when the campaign was last updated, in ISO 8601 format.
Limits	CampaignLimits	The campaign limits settings.
MessageConfiguration	MessageConfiguration	The message configuration settings.
Name	string	The custom name of the campaign.
Schedule	Schedule	The campaign schedule.
SegmentId	string	The ID of the segment to which the campaign sends messages.
SegmentVersion	integer	The version of the segment to which the campaign sends messages.
State	CampaignState	The campaign status. An A/B test campaign will have a status of COMPLETED only when all treatments have a status of COMPLETED.
TreatmentDescription	string	A custom description for the treatment.
TreatmentName	string	The custom name of a variation of the campaign used for A/B testing.
Version	integer	The campaign version number.
tags	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.

TreatmentResource

Attribute	Type	Description
Id	string	The unique treatment ID.
MessageConfiguration	MessageConfiguration	The message configuration settings.
Schedule	Schedule	The campaign schedule.
SizePercent	integer	The allocated percentage of users for this treatment.
State	CampaignState	The treatment status.
TreatmentDescription	string	A custom description for the treatment.
TreatmentName	string	The custom name of a variation of the campaign used for A/B testing.

MessageConfiguration

Attribute	Type	Description
ADMMessage	Message	The message that the campaign delivers to ADM channels. Overrides the default message.
APNSMessage	Message	The message that the campaign delivers to APNs channels. Overrides the default message.
BaiduMessage	Message	The message that the campaign delivers to Baidu channels. Overrides the default message.
DefaultMessage	Message	The default message for all channels.
EmailMessage	CampaignEmailMessage	The email message configuration.
GCMMessage	Message	The message that the campaign delivers to GCM channels. Overrides the default message.
SMSMessage	CampaignSmsMessage	The SMS message configuration.

Message

Attribute	Type	Description
Action	string	The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.
Body	string	The message body. Can include up to 140 characters.
ImageIconUrl	string	The URL that points to the icon image for the push notification icon, for example, the app icon.
ImageSmallIconUrl	string	The URL that points to the small icon image for the push notification icon, for example, the app icon.
ImageUrl	string	The URL that points to an image used in the push notification.
JsonBody	string	The JSON payload used for a silent push.
MediaUrl	string	A URL that refers to the location of an image or video that you want to display in the push notification.
RawContent	string	The Raw JSON formatted string to be used as the payload. This value overrides the message.
SilentPush	boolean	Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.
TimeToLive	integer	This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM
Title	string	The message title that displays above the message on the user's device.
Url	string	The URL to open in the user's mobile browser. Used if the value for Action is URL.

CampaignEmailMessage

Attribute	Type	Description
Body	string	The email text body.
FromAddress	string	The email address used to send the email from. Defaults to use the FromAddress specified for the email channel.
HtmlBody	string	The email HTML body.
Title	string	The email title (or subject).

CampaignSmsMessage

Attribute	Type	Description
Body	string	The SMS text body.
MessageType	string	Is this a transactional SMS message, otherwise a promotional message.
SenderId	string	The Sender ID of the sent message.

Schedule

Attribute	Type	Description
EndTime	string	The scheduled time when the campaign ends, in ISO 8601 format.
EventFilter	CampaignEventFilter	Defines the type of events that can trigger the campaign. Used when Frequency is set to EVENT.
Frequency	string	How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY, EVENT
IsLocalTime	boolean	Indicates whether the campaign schedule takes effect according to each user's local time.
QuietTime	QuietTime	The default quiet time for the campaign. The campaign doesn't send messages to endpoints during the quiet time. Note: Make sure that your endpoints include the Demographics.Timezone attribute if you plan to enable a quiet time for your campaign. If your endpoints don't include this attribute, they'll receive the messages that you send them, even if quiet time is enabled. When you set up a campaign to use quiet time, the campaign doesn't send messages during the time range you specified, as long as all of the following are true: - The endpoint includes a valid Demographic.Timezone attribute. - The current time in the endpoint's time zone is later than or equal to the time specified in the QuietTime.Start attribute for the campaign. - The current time in the endpoint's time zone is earlier than or equal to the time specified in the QuietTime.End attribute for the campaign.
StartTime	string	The scheduled time when the campaign begins, in ISO 8601 format.
Timezone	string	The starting UTC offset for the schedule if the value for isLocalTime is true. Valid values: 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 UTC-11

CampaignEventFilter

Attribute	Type	Description
Dimensions	EventDimensions	An object that defines the dimensions for the event filter.
FilterType	string	The type of event that causes the campaign to be sent. Possible values: SYSTEM - Send the campaign when a system event occurs. ENDPOINT - Send the campaign when an endpoint event occurs. See the Events resource for more information.

Attribute

Type

Description

Dimensions

EventDimensions

An object that defines the dimensions for the event filter.

FilterType

string

The type of event that causes the campaign to be sent. Possible values:

SYSTEM - Send the campaign when a system event occurs.

ENDPOINT - Send the campaign when an endpoint event occurs. See the Events resource for more information.

EventDimensions

Attribute	Type	Description
Attributes	object	Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
EventType	SetDimension	The name of the event that causes the campaign to be sent. This can be a standard event type that Amazon Pinpoint generates, such as _session.start, or a custom event that's specific to your app.
Metrics	object	Custom metrics that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.

AttributeDimension

Attribute	Type	Description
AttributeType	string	The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values	array	The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.

Attribute

Type

Description

AttributeType

string

The type of dimension:

INCLUSIVE - Endpoints that match the criteria are included in the segment.

EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.

Values

array

The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.

SetDimension

Attribute	Type	Description
DimensionType	string	The type of dimension: INCLUSIVE - Endpoints that match the criteria are included in the segment. EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.
Values	array	The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.

Attribute

Type

Description

DimensionType

string

The type of dimension:

INCLUSIVE - Endpoints that match the criteria are included in the segment.

EXCLUSIVE - Endpoints that match the criteria are excluded from the segment.

Values

array

The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type.

MetricDimension

Attribute	Type	Description
ComparisonOperator	string	The operator that you're using to compare metric values. Possible values: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, or EQUAL
Value	number	The value to be compared.

QuietTime

Attribute	Type	Description
End	string	The time when quiet time should end. The value that you specify has to be in HH:MM format, where HH is the hour in 24-hour format (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.
Start	string	The time when quiet time should begin. The value that you specify has to be in HH:MM format, where HH is the hour in 24-hour format (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.

CampaignState

Attribute	Type	Description
CampaignStatus	string	The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED

Attribute

Type

Description

CampaignStatus

string

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

Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED

CampaignHook

Attribute	Type	Description
LambdaFunctionName	string	The Lambda function name or ARN to be called for delivery.
Mode	string	What mode Lambda should be invoked in.
WebUrl	string	The web URL to call for the hook. If the URL has authentication specified, it will be added as authentication to the request.

CampaignLimits

Attribute	Type	Description
Daily	integer	The maximum number of messages that each campaign can send to a single endpoint during a 24-hour period.
MaximumDuration	integer	The length of time (in seconds) that the campaign can run before it ends and message deliveries stop. This duration begins at the scheduled start time for the campaign. The minimum value is 60.
MessagesPerSecond	integer	The number of messages that the campaign can send per second. The minimum value is 50. The maximum value is 20000.
Total	integer	The maximum number of messages that an individual campaign can send to a single endpoint over the course of the campaign.

MessageBody

Attribute	Type	Description
Message	string	The error message that's returned from the API.
RequestID	string	The unique message body ID.

Warning Javascript is disabled or is unavailable in your browser.

To use the AWS Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.

Document Conventions

« Previous Next »