Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . pinpoint ]

update-campaign

Description

Use to update a campaign.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-campaign
--application-id <value>
--campaign-id <value>
--write-campaign-request <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--application-id (string) The unique ID of your Amazon Pinpoint application.

--campaign-id (string) The unique ID of the campaign.

--write-campaign-request (structure) Used to create a campaign.

JSON Syntax:

{
  "AdditionalTreatments": [
    {
      "MessageConfiguration": {
        "ADMMessage": {
          "Action": "OPEN_APP"|"DEEP_LINK"|"URL",
          "Body": "string",
          "ImageIconUrl": "string",
          "ImageSmallIconUrl": "string",
          "ImageUrl": "string",
          "JsonBody": "string",
          "MediaUrl": "string",
          "RawContent": "string",
          "SilentPush": true|false,
          "TimeToLive": integer,
          "Title": "string",
          "Url": "string"
        },
        "APNSMessage": {
          "Action": "OPEN_APP"|"DEEP_LINK"|"URL",
          "Body": "string",
          "ImageIconUrl": "string",
          "ImageSmallIconUrl": "string",
          "ImageUrl": "string",
          "JsonBody": "string",
          "MediaUrl": "string",
          "RawContent": "string",
          "SilentPush": true|false,
          "TimeToLive": integer,
          "Title": "string",
          "Url": "string"
        },
        "BaiduMessage": {
          "Action": "OPEN_APP"|"DEEP_LINK"|"URL",
          "Body": "string",
          "ImageIconUrl": "string",
          "ImageSmallIconUrl": "string",
          "ImageUrl": "string",
          "JsonBody": "string",
          "MediaUrl": "string",
          "RawContent": "string",
          "SilentPush": true|false,
          "TimeToLive": integer,
          "Title": "string",
          "Url": "string"
        },
        "DefaultMessage": {
          "Action": "OPEN_APP"|"DEEP_LINK"|"URL",
          "Body": "string",
          "ImageIconUrl": "string",
          "ImageSmallIconUrl": "string",
          "ImageUrl": "string",
          "JsonBody": "string",
          "MediaUrl": "string",
          "RawContent": "string",
          "SilentPush": true|false,
          "TimeToLive": integer,
          "Title": "string",
          "Url": "string"
        },
        "EmailMessage": {
          "Body": "string",
          "FromAddress": "string",
          "HtmlBody": "string",
          "Title": "string"
        },
        "GCMMessage": {
          "Action": "OPEN_APP"|"DEEP_LINK"|"URL",
          "Body": "string",
          "ImageIconUrl": "string",
          "ImageSmallIconUrl": "string",
          "ImageUrl": "string",
          "JsonBody": "string",
          "MediaUrl": "string",
          "RawContent": "string",
          "SilentPush": true|false,
          "TimeToLive": integer,
          "Title": "string",
          "Url": "string"
        },
        "SMSMessage": {
          "Body": "string",
          "MessageType": "TRANSACTIONAL"|"PROMOTIONAL",
          "SenderId": "string"
        }
      },
      "Schedule": {
        "EndTime": "string",
        "EventFilter": {
          "Dimensions": {
            "Attributes": {"string": {
                  "AttributeType": "INCLUSIVE"|"EXCLUSIVE",
                  "Values": ["string", ...]
                }
              ...},
            "EventType": {
              "DimensionType": "INCLUSIVE"|"EXCLUSIVE",
              "Values": ["string", ...]
            },
            "Metrics": {"string": {
                  "ComparisonOperator": "string",
                  "Value": double
                }
              ...}
          },
          "FilterType": "SYSTEM"|"ENDPOINT"
        },
        "Frequency": "ONCE"|"HOURLY"|"DAILY"|"WEEKLY"|"MONTHLY"|"EVENT",
        "IsLocalTime": true|false,
        "QuietTime": {
          "End": "string",
          "Start": "string"
        },
        "StartTime": "string",
        "Timezone": "string"
      },
      "SizePercent": integer,
      "TreatmentDescription": "string",
      "TreatmentName": "string"
    }
    ...
  ],
  "Description": "string",
  "HoldoutPercent": integer,
  "Hook": {
    "LambdaFunctionName": "string",
    "Mode": "DELIVERY"|"FILTER",
    "WebUrl": "string"
  },
  "IsPaused": true|false,
  "Limits": {
    "Daily": integer,
    "MaximumDuration": integer,
    "MessagesPerSecond": integer,
    "Total": integer
  },
  "MessageConfiguration": {
    "ADMMessage": {
      "Action": "OPEN_APP"|"DEEP_LINK"|"URL",
      "Body": "string",
      "ImageIconUrl": "string",
      "ImageSmallIconUrl": "string",
      "ImageUrl": "string",
      "JsonBody": "string",
      "MediaUrl": "string",
      "RawContent": "string",
      "SilentPush": true|false,
      "TimeToLive": integer,
      "Title": "string",
      "Url": "string"
    },
    "APNSMessage": {
      "Action": "OPEN_APP"|"DEEP_LINK"|"URL",
      "Body": "string",
      "ImageIconUrl": "string",
      "ImageSmallIconUrl": "string",
      "ImageUrl": "string",
      "JsonBody": "string",
      "MediaUrl": "string",
      "RawContent": "string",
      "SilentPush": true|false,
      "TimeToLive": integer,
      "Title": "string",
      "Url": "string"
    },
    "BaiduMessage": {
      "Action": "OPEN_APP"|"DEEP_LINK"|"URL",
      "Body": "string",
      "ImageIconUrl": "string",
      "ImageSmallIconUrl": "string",
      "ImageUrl": "string",
      "JsonBody": "string",
      "MediaUrl": "string",
      "RawContent": "string",
      "SilentPush": true|false,
      "TimeToLive": integer,
      "Title": "string",
      "Url": "string"
    },
    "DefaultMessage": {
      "Action": "OPEN_APP"|"DEEP_LINK"|"URL",
      "Body": "string",
      "ImageIconUrl": "string",
      "ImageSmallIconUrl": "string",
      "ImageUrl": "string",
      "JsonBody": "string",
      "MediaUrl": "string",
      "RawContent": "string",
      "SilentPush": true|false,
      "TimeToLive": integer,
      "Title": "string",
      "Url": "string"
    },
    "EmailMessage": {
      "Body": "string",
      "FromAddress": "string",
      "HtmlBody": "string",
      "Title": "string"
    },
    "GCMMessage": {
      "Action": "OPEN_APP"|"DEEP_LINK"|"URL",
      "Body": "string",
      "ImageIconUrl": "string",
      "ImageSmallIconUrl": "string",
      "ImageUrl": "string",
      "JsonBody": "string",
      "MediaUrl": "string",
      "RawContent": "string",
      "SilentPush": true|false,
      "TimeToLive": integer,
      "Title": "string",
      "Url": "string"
    },
    "SMSMessage": {
      "Body": "string",
      "MessageType": "TRANSACTIONAL"|"PROMOTIONAL",
      "SenderId": "string"
    }
  },
  "Name": "string",
  "Schedule": {
    "EndTime": "string",
    "EventFilter": {
      "Dimensions": {
        "Attributes": {"string": {
              "AttributeType": "INCLUSIVE"|"EXCLUSIVE",
              "Values": ["string", ...]
            }
          ...},
        "EventType": {
          "DimensionType": "INCLUSIVE"|"EXCLUSIVE",
          "Values": ["string", ...]
        },
        "Metrics": {"string": {
              "ComparisonOperator": "string",
              "Value": double
            }
          ...}
      },
      "FilterType": "SYSTEM"|"ENDPOINT"
    },
    "Frequency": "ONCE"|"HOURLY"|"DAILY"|"WEEKLY"|"MONTHLY"|"EVENT",
    "IsLocalTime": true|false,
    "QuietTime": {
      "End": "string",
      "Start": "string"
    },
    "StartTime": "string",
    "Timezone": "string"
  },
  "SegmentId": "string",
  "SegmentVersion": integer,
  "TreatmentDescription": "string",
  "TreatmentName": "string"
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

CampaignResponse -> (structure)

Campaign definition

AdditionalTreatments -> (list)

Treatments that are defined in addition to the default treatment.

(structure)

Treatment resource

Id -> (string)

The unique treatment ID.

MessageConfiguration -> (structure)

The message configuration settings.

ADMMessage -> (structure)

The message that the campaign delivers to ADM channels. Overrides the default message.

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.

APNSMessage -> (structure)

The message that the campaign delivers to APNS channels. Overrides the default message.

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.

BaiduMessage -> (structure)

The message that the campaign delivers to Baidu channels. Overrides the default message.

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.

DefaultMessage -> (structure)

The default message for all channels.

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.

EmailMessage -> (structure)

The email message configuration.

Body -> (string)

The email text body.

FromAddress -> (string)

The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.

HtmlBody -> (string)

The email html body.

Title -> (string)

The email title (Or subject).

GCMMessage -> (structure)

The message that the campaign delivers to GCM channels. Overrides the default message.

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.

SMSMessage -> (structure)

The SMS message configuration.

Body -> (string)

The SMS text body.

MessageType -> (string)

Is this is a transactional SMS message, otherwise a promotional message.

SenderId -> (string)

Sender ID of sent message.

Schedule -> (structure)

The campaign schedule.

EndTime -> (string)

The scheduled time that the campaign ends in ISO 8601 format.

EventFilter -> (structure)

Defines the type of events that can trigger the campaign. Used when the Frequency is set to EVENT.

Dimensions -> (structure)

An object that defines the dimensions for the event filter.

Attributes -> (map)

Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.

key -> (string)

value -> (structure)

Custom attibute dimension

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 -> (list)

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.

(string)

EventType -> (structure)

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.

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 -> (list)

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.

(string)

Metrics -> (map)

Custom metrics that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.

key -> (string)

value -> (structure)

Custom metric dimension

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 -> (double)

The value to be compared.

FilterType -> (string)

The type of event that causes the campaign to be sent. Possible values: SYSTEM - Send the campaign when a system event occurs. See the System resource for more information. ENDPOINT - Send the campaign when an endpoint event occurs. See the Event resource for more information.

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 -> (structure)

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.

End -> (string)

The time at which 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 at which 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.

StartTime -> (string)

The scheduled time that 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

SizePercent -> (integer)

The allocated percentage of users for this treatment.

State -> (structure)

The treatment status.

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

TreatmentDescription -> (string)

A custom description for the treatment.

TreatmentName -> (string)

The custom name of a variation of the campaign used for A/B testing.

ApplicationId -> (string)

The ID of the application to which the campaign applies.

CreationDate -> (string)

The date the campaign was created in ISO 8601 format.

DefaultState -> (structure)

The status of the campaign's default treatment. Only present for A/B test campaigns.

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

Description -> (string)

A description of the campaign.

HoldoutPercent -> (integer)

The allocated percentage of end users who will not receive messages from this campaign.

Hook -> (structure)

Campaign hook information.

LambdaFunctionName -> (string)

Lambda function name or arn to be called for delivery

Mode -> (string)

What mode Lambda should be invoked in.

WebUrl -> (string)

Web URL to call for hook. If the URL has authentication specified it will be added as authentication to the request

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 the campaign was last updated in ISO 8601 format.

Limits -> (structure)

The campaign limits settings.

Daily -> (integer)

The maximum number of messages that each campaign can send to a single endpoint in 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, and the maximum 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.

MessageConfiguration -> (structure)

The message configuration settings.

ADMMessage -> (structure)

The message that the campaign delivers to ADM channels. Overrides the default message.

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.

APNSMessage -> (structure)

The message that the campaign delivers to APNS channels. Overrides the default message.

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.

BaiduMessage -> (structure)

The message that the campaign delivers to Baidu channels. Overrides the default message.

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.

DefaultMessage -> (structure)

The default message for all channels.

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.

EmailMessage -> (structure)

The email message configuration.

Body -> (string)

The email text body.

FromAddress -> (string)

The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.

HtmlBody -> (string)

The email html body.

Title -> (string)

The email title (Or subject).

GCMMessage -> (structure)

The message that the campaign delivers to GCM channels. Overrides the default message.

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.

SMSMessage -> (structure)

The SMS message configuration.

Body -> (string)

The SMS text body.

MessageType -> (string)

Is this is a transactional SMS message, otherwise a promotional message.

SenderId -> (string)

Sender ID of sent message.

Name -> (string)

The custom name of the campaign.

Schedule -> (structure)

The campaign schedule.

EndTime -> (string)

The scheduled time that the campaign ends in ISO 8601 format.

EventFilter -> (structure)

Defines the type of events that can trigger the campaign. Used when the Frequency is set to EVENT.

Dimensions -> (structure)

An object that defines the dimensions for the event filter.

Attributes -> (map)

Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.

key -> (string)

value -> (structure)

Custom attibute dimension

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 -> (list)

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.

(string)

EventType -> (structure)

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.

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 -> (list)

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.

(string)

Metrics -> (map)

Custom metrics that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.

key -> (string)

value -> (structure)

Custom metric dimension

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 -> (double)

The value to be compared.

FilterType -> (string)

The type of event that causes the campaign to be sent. Possible values: SYSTEM - Send the campaign when a system event occurs. See the System resource for more information. ENDPOINT - Send the campaign when an endpoint event occurs. See the Event resource for more information.

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 -> (structure)

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.

End -> (string)

The time at which 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 at which 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.

StartTime -> (string)

The scheduled time that 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

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 -> (structure)

The campaign status. An A/B test campaign will have a status of COMPLETED only when all treatments have a status of COMPLETED.

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

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.