Class: AWS.Pinpoint

Inherits:
AWS.Service show all
Identifier:
pinpoint
API Version:
2016-12-01
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Amazon Pinpoint

Sending a Request Using Pinpoint

var pinpoint = new AWS.Pinpoint();
pinpoint.createApp(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the Pinpoint object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var pinpoint = new AWS.Pinpoint({apiVersion: '2016-12-01'});

You can also set the API version globally in AWS.config.apiVersions using the pinpoint service identifier:

AWS.config.apiVersions = {
  pinpoint: '2016-12-01',
  // other service API versions
};

var pinpoint = new AWS.Pinpoint();

Version:

  • 2016-12-01

Constructor Summary

Property Summary

Properties inherited from AWS.Service

apiVersions

Method Summary

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.Pinpoint(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a Pinpoint object

var pinpoint = new AWS.Pinpoint({apiVersion: '2016-12-01'});

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.Pinpoint.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.Pinpoint.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.Pinpoint.maxRedirects for more information.

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean) —

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean) —

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean) —

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean) —

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • retryDelayOptions (map) —

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • httpOptions (map) —

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date) —

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>) —

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log) —

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number) —

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String) —

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean) —

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean) —

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean) —

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

createApp(params = {}, callback) ⇒ AWS.Request

Creates or updates an app.

Service Reference:

Examples:

Calling the createApp operation

var params = {
  CreateApplicationRequest: { /* required */
    Name: 'STRING_VALUE',
    tags: {
      '<__string>': 'STRING_VALUE',
      /* '<__string>': ... */
    }
  }
};
pinpoint.createApp(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • CreateApplicationRequest — (map) Application Request.
      • Name — (String) The display name of the application. Used in the Amazon Pinpoint console.
      • tags — (map<String>) The Tags for the app.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationResponse — (map) Application Response.
        • Arn — (String) The arn for the application.
        • Id — (String) The unique application ID.
        • Name — (String) The display name of the application.
        • tags — (map<String>) The Tags for the application.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createCampaign(params = {}, callback) ⇒ AWS.Request

Creates or updates a campaign.

Service Reference:

Examples:

Calling the createCampaign operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  WriteCampaignRequest: { /* required */
    AdditionalTreatments: [
      {
        MessageConfiguration: {
          ADMMessage: {
            Action: OPEN_APP | DEEP_LINK | URL,
            Body: 'STRING_VALUE',
            ImageIconUrl: 'STRING_VALUE',
            ImageSmallIconUrl: 'STRING_VALUE',
            ImageUrl: 'STRING_VALUE',
            JsonBody: 'STRING_VALUE',
            MediaUrl: 'STRING_VALUE',
            RawContent: 'STRING_VALUE',
            SilentPush: true || false,
            TimeToLive: 'NUMBER_VALUE',
            Title: 'STRING_VALUE',
            Url: 'STRING_VALUE'
          },
          APNSMessage: {
            Action: OPEN_APP | DEEP_LINK | URL,
            Body: 'STRING_VALUE',
            ImageIconUrl: 'STRING_VALUE',
            ImageSmallIconUrl: 'STRING_VALUE',
            ImageUrl: 'STRING_VALUE',
            JsonBody: 'STRING_VALUE',
            MediaUrl: 'STRING_VALUE',
            RawContent: 'STRING_VALUE',
            SilentPush: true || false,
            TimeToLive: 'NUMBER_VALUE',
            Title: 'STRING_VALUE',
            Url: 'STRING_VALUE'
          },
          BaiduMessage: {
            Action: OPEN_APP | DEEP_LINK | URL,
            Body: 'STRING_VALUE',
            ImageIconUrl: 'STRING_VALUE',
            ImageSmallIconUrl: 'STRING_VALUE',
            ImageUrl: 'STRING_VALUE',
            JsonBody: 'STRING_VALUE',
            MediaUrl: 'STRING_VALUE',
            RawContent: 'STRING_VALUE',
            SilentPush: true || false,
            TimeToLive: 'NUMBER_VALUE',
            Title: 'STRING_VALUE',
            Url: 'STRING_VALUE'
          },
          DefaultMessage: {
            Action: OPEN_APP | DEEP_LINK | URL,
            Body: 'STRING_VALUE',
            ImageIconUrl: 'STRING_VALUE',
            ImageSmallIconUrl: 'STRING_VALUE',
            ImageUrl: 'STRING_VALUE',
            JsonBody: 'STRING_VALUE',
            MediaUrl: 'STRING_VALUE',
            RawContent: 'STRING_VALUE',
            SilentPush: true || false,
            TimeToLive: 'NUMBER_VALUE',
            Title: 'STRING_VALUE',
            Url: 'STRING_VALUE'
          },
          EmailMessage: {
            Body: 'STRING_VALUE',
            FromAddress: 'STRING_VALUE',
            HtmlBody: 'STRING_VALUE',
            Title: 'STRING_VALUE'
          },
          GCMMessage: {
            Action: OPEN_APP | DEEP_LINK | URL,
            Body: 'STRING_VALUE',
            ImageIconUrl: 'STRING_VALUE',
            ImageSmallIconUrl: 'STRING_VALUE',
            ImageUrl: 'STRING_VALUE',
            JsonBody: 'STRING_VALUE',
            MediaUrl: 'STRING_VALUE',
            RawContent: 'STRING_VALUE',
            SilentPush: true || false,
            TimeToLive: 'NUMBER_VALUE',
            Title: 'STRING_VALUE',
            Url: 'STRING_VALUE'
          },
          SMSMessage: {
            Body: 'STRING_VALUE',
            MessageType: TRANSACTIONAL | PROMOTIONAL,
            SenderId: 'STRING_VALUE'
          }
        },
        Schedule: {
          EndTime: 'STRING_VALUE',
          EventFilter: {
            Dimensions: {
              Attributes: {
                '<__string>': {
                  AttributeType: INCLUSIVE | EXCLUSIVE,
                  Values: [
                    'STRING_VALUE',
                    /* more items */
                  ]
                },
                /* '<__string>': ... */
              },
              EventType: {
                DimensionType: INCLUSIVE | EXCLUSIVE,
                Values: [
                  'STRING_VALUE',
                  /* more items */
                ]
              },
              Metrics: {
                '<__string>': {
                  ComparisonOperator: 'STRING_VALUE',
                  Value: 'NUMBER_VALUE'
                },
                /* '<__string>': ... */
              }
            },
            FilterType: SYSTEM | ENDPOINT
          },
          Frequency: ONCE | HOURLY | DAILY | WEEKLY | MONTHLY | EVENT,
          IsLocalTime: true || false,
          QuietTime: {
            End: 'STRING_VALUE',
            Start: 'STRING_VALUE'
          },
          StartTime: 'STRING_VALUE',
          Timezone: 'STRING_VALUE'
        },
        SizePercent: 'NUMBER_VALUE',
        TreatmentDescription: 'STRING_VALUE',
        TreatmentName: 'STRING_VALUE'
      },
      /* more items */
    ],
    Description: 'STRING_VALUE',
    HoldoutPercent: 'NUMBER_VALUE',
    Hook: {
      LambdaFunctionName: 'STRING_VALUE',
      Mode: DELIVERY | FILTER,
      WebUrl: 'STRING_VALUE'
    },
    IsPaused: true || false,
    Limits: {
      Daily: 'NUMBER_VALUE',
      MaximumDuration: 'NUMBER_VALUE',
      MessagesPerSecond: 'NUMBER_VALUE',
      Total: 'NUMBER_VALUE'
    },
    MessageConfiguration: {
      ADMMessage: {
        Action: OPEN_APP | DEEP_LINK | URL,
        Body: 'STRING_VALUE',
        ImageIconUrl: 'STRING_VALUE',
        ImageSmallIconUrl: 'STRING_VALUE',
        ImageUrl: 'STRING_VALUE',
        JsonBody: 'STRING_VALUE',
        MediaUrl: 'STRING_VALUE',
        RawContent: 'STRING_VALUE',
        SilentPush: true || false,
        TimeToLive: 'NUMBER_VALUE',
        Title: 'STRING_VALUE',
        Url: 'STRING_VALUE'
      },
      APNSMessage: {
        Action: OPEN_APP | DEEP_LINK | URL,
        Body: 'STRING_VALUE',
        ImageIconUrl: 'STRING_VALUE',
        ImageSmallIconUrl: 'STRING_VALUE',
        ImageUrl: 'STRING_VALUE',
        JsonBody: 'STRING_VALUE',
        MediaUrl: 'STRING_VALUE',
        RawContent: 'STRING_VALUE',
        SilentPush: true || false,
        TimeToLive: 'NUMBER_VALUE',
        Title: 'STRING_VALUE',
        Url: 'STRING_VALUE'
      },
      BaiduMessage: {
        Action: OPEN_APP | DEEP_LINK | URL,
        Body: 'STRING_VALUE',
        ImageIconUrl: 'STRING_VALUE',
        ImageSmallIconUrl: 'STRING_VALUE',
        ImageUrl: 'STRING_VALUE',
        JsonBody: 'STRING_VALUE',
        MediaUrl: 'STRING_VALUE',
        RawContent: 'STRING_VALUE',
        SilentPush: true || false,
        TimeToLive: 'NUMBER_VALUE',
        Title: 'STRING_VALUE',
        Url: 'STRING_VALUE'
      },
      DefaultMessage: {
        Action: OPEN_APP | DEEP_LINK | URL,
        Body: 'STRING_VALUE',
        ImageIconUrl: 'STRING_VALUE',
        ImageSmallIconUrl: 'STRING_VALUE',
        ImageUrl: 'STRING_VALUE',
        JsonBody: 'STRING_VALUE',
        MediaUrl: 'STRING_VALUE',
        RawContent: 'STRING_VALUE',
        SilentPush: true || false,
        TimeToLive: 'NUMBER_VALUE',
        Title: 'STRING_VALUE',
        Url: 'STRING_VALUE'
      },
      EmailMessage: {
        Body: 'STRING_VALUE',
        FromAddress: 'STRING_VALUE',
        HtmlBody: 'STRING_VALUE',
        Title: 'STRING_VALUE'
      },
      GCMMessage: {
        Action: OPEN_APP | DEEP_LINK | URL,
        Body: 'STRING_VALUE',
        ImageIconUrl: 'STRING_VALUE',
        ImageSmallIconUrl: 'STRING_VALUE',
        ImageUrl: 'STRING_VALUE',
        JsonBody: 'STRING_VALUE',
        MediaUrl: 'STRING_VALUE',
        RawContent: 'STRING_VALUE',
        SilentPush: true || false,
        TimeToLive: 'NUMBER_VALUE',
        Title: 'STRING_VALUE',
        Url: 'STRING_VALUE'
      },
      SMSMessage: {
        Body: 'STRING_VALUE',
        MessageType: TRANSACTIONAL | PROMOTIONAL,
        SenderId: 'STRING_VALUE'
      }
    },
    Name: 'STRING_VALUE',
    Schedule: {
      EndTime: 'STRING_VALUE',
      EventFilter: {
        Dimensions: {
          Attributes: {
            '<__string>': {
              AttributeType: INCLUSIVE | EXCLUSIVE,
              Values: [
                'STRING_VALUE',
                /* more items */
              ]
            },
            /* '<__string>': ... */
          },
          EventType: {
            DimensionType: INCLUSIVE | EXCLUSIVE,
            Values: [
              'STRING_VALUE',
              /* more items */
            ]
          },
          Metrics: {
            '<__string>': {
              ComparisonOperator: 'STRING_VALUE',
              Value: 'NUMBER_VALUE'
            },
            /* '<__string>': ... */
          }
        },
        FilterType: SYSTEM | ENDPOINT
      },
      Frequency: ONCE | HOURLY | DAILY | WEEKLY | MONTHLY | EVENT,
      IsLocalTime: true || false,
      QuietTime: {
        End: 'STRING_VALUE',
        Start: 'STRING_VALUE'
      },
      StartTime: 'STRING_VALUE',
      Timezone: 'STRING_VALUE'
    },
    SegmentId: 'STRING_VALUE',
    SegmentVersion: 'NUMBER_VALUE',
    TreatmentDescription: 'STRING_VALUE',
    TreatmentName: 'STRING_VALUE',
    tags: {
      '<__string>': 'STRING_VALUE',
      /* '<__string>': ... */
    }
  }
};
pinpoint.createCampaign(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.
    • WriteCampaignRequest — (map) Used to create a campaign.
      • AdditionalTreatments — (Array<map>) Treatments that are defined in addition to the default treatment.
        • MessageConfiguration — (map) The message configuration settings.
          • ADMMessage — (map) 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. Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • 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 — (map) 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. Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • 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 — (map) 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. Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • 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 — (map) 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. Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • 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 — (map) 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 — (map) 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. Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • 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 — (map) The SMS message configuration.
            • Body — (String) The SMS text body.
            • MessageType — (String) Is this is a transactional SMS message, otherwise a promotional message. Possible values include:
              • "TRANSACTIONAL"
              • "PROMOTIONAL"
            • SenderId — (String) Sender ID of sent message.
        • Schedule — (map) The campaign schedule.
          • EndTime — (String) The scheduled time that the campaign ends in ISO 8601 format.
          • EventFilter — (map) Defines the type of events that can trigger the campaign. Used when the Frequency is set to EVENT.
            • Dimensions — (map) An object that defines the dimensions for the event filter.
              • Attributes — (map<map>) Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
                • 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. Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Values — (Array<String>) 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.
              • EventType — (map) 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. Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Values — (Array<String>) 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.
              • Metrics — (map<map>) Custom metrics that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
                • 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 — (Float) 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. Possible values include:
              • "SYSTEM"
              • "ENDPOINT"
          • Frequency — (String) How often the campaign delivers messages. Valid values: ONCE HOURLY DAILY WEEKLY MONTHLY EVENT Possible values include:
            • "ONCE"
            • "HOURLY"
            • "DAILY"
            • "WEEKLY"
            • "MONTHLY"
            • "EVENT"
          • IsLocalTime — (Boolean) Indicates whether the campaign schedule takes effect according to each user's local time.
          • QuietTime — (map) 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.
        • TreatmentDescription — (String) A custom description for the treatment.
        • TreatmentName — (String) The custom name of a variation of the campaign used for A/B testing.
      • Description — (String) A description of the campaign.
      • HoldoutPercent — (Integer) The allocated percentage of end users who will not receive messages from this campaign.
      • Hook — (map) Campaign hook information.
        • LambdaFunctionName — (String) Lambda function name or arn to be called for delivery
        • Mode — (String) What mode Lambda should be invoked in. Possible values include:
          • "DELIVERY"
          • "FILTER"
        • WebUrl — (String) Web URL to call for hook. If the URL has authentication specified it will be added as authentication to the request
      • IsPaused — (Boolean) Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.
      • Limits — (map) 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 — (map) The message configuration settings.
        • ADMMessage — (map) 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. Possible values include:
            • "OPEN_APP"
            • "DEEP_LINK"
            • "URL"
          • 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 — (map) 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. Possible values include:
            • "OPEN_APP"
            • "DEEP_LINK"
            • "URL"
          • 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 — (map) 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. Possible values include:
            • "OPEN_APP"
            • "DEEP_LINK"
            • "URL"
          • 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 — (map) 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. Possible values include:
            • "OPEN_APP"
            • "DEEP_LINK"
            • "URL"
          • 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 — (map) 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 — (map) 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. Possible values include:
            • "OPEN_APP"
            • "DEEP_LINK"
            • "URL"
          • 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 — (map) The SMS message configuration.
          • Body — (String) The SMS text body.
          • MessageType — (String) Is this is a transactional SMS message, otherwise a promotional message. Possible values include:
            • "TRANSACTIONAL"
            • "PROMOTIONAL"
          • SenderId — (String) Sender ID of sent message.
      • Name — (String) The custom name of the campaign.
      • Schedule — (map) The campaign schedule.
        • EndTime — (String) The scheduled time that the campaign ends in ISO 8601 format.
        • EventFilter — (map) Defines the type of events that can trigger the campaign. Used when the Frequency is set to EVENT.
          • Dimensions — (map) An object that defines the dimensions for the event filter.
            • Attributes — (map<map>) Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
              • 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. Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Values — (Array<String>) 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.
            • EventType — (map) 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. Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Values — (Array<String>) 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.
            • Metrics — (map<map>) Custom metrics that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
              • 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 — (Float) 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. Possible values include:
            • "SYSTEM"
            • "ENDPOINT"
        • Frequency — (String) How often the campaign delivers messages. Valid values: ONCE HOURLY DAILY WEEKLY MONTHLY EVENT Possible values include:
          • "ONCE"
          • "HOURLY"
          • "DAILY"
          • "WEEKLY"
          • "MONTHLY"
          • "EVENT"
        • IsLocalTime — (Boolean) Indicates whether the campaign schedule takes effect according to each user's local time.
        • QuietTime — (map) 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.
      • tags — (map<String>) The Tags for the campaign.
      • TreatmentDescription — (String) A custom description for the treatment.
      • TreatmentName — (String) The custom name of a variation of the campaign used for A/B testing.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CampaignResponse — (map) Campaign definition
        • AdditionalTreatments — (Array<map>) Treatments that are defined in addition to the default treatment.
          • Id — (String) The unique treatment ID.
          • MessageConfiguration — (map) The message configuration settings.
            • ADMMessage — (map) 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. Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • 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 — (map) 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. Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • 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 — (map) 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. Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • 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 — (map) 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. Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • 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 — (map) 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 — (map) 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. Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • 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 — (map) The SMS message configuration.
              • Body — (String) The SMS text body.
              • MessageType — (String) Is this is a transactional SMS message, otherwise a promotional message. Possible values include:
                • "TRANSACTIONAL"
                • "PROMOTIONAL"
              • SenderId — (String) Sender ID of sent message.
          • Schedule — (map) The campaign schedule.
            • EndTime — (String) The scheduled time that the campaign ends in ISO 8601 format.
            • EventFilter — (map) Defines the type of events that can trigger the campaign. Used when the Frequency is set to EVENT.
              • Dimensions — (map) An object that defines the dimensions for the event filter.
                • Attributes — (map<map>) Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
                  • 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
                • EventType — (map) 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
                • Metrics — (map<map>) Custom metrics that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
                  • 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 — (Float) 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. Possible values include:
                • "SYSTEM"
                • "ENDPOINT"
            • Frequency — (String) How often the campaign delivers messages. Valid values: ONCE HOURLY DAILY WEEKLY MONTHLY EVENT Possible values include:
              • "ONCE"
              • "HOURLY"
              • "DAILY"
              • "WEEKLY"
              • "MONTHLY"
              • "EVENT"
            • IsLocalTime — (Boolean) Indicates whether the campaign schedule takes effect according to each user's local time.
            • QuietTime — (map) 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 — (map) 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 Possible values include:
              • "SCHEDULED"
              • "EXECUTING"
              • "PENDING_NEXT_RUN"
              • "COMPLETED"
              • "PAUSED"
              • "DELETED"
          • 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.
        • Arn — (String) The arn for the campaign.
        • CreationDate — (String) The date the campaign was created in ISO 8601 format.
        • DefaultState — (map) 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 Possible values include:
            • "SCHEDULED"
            • "EXECUTING"
            • "PENDING_NEXT_RUN"
            • "COMPLETED"
            • "PAUSED"
            • "DELETED"
        • Description — (String) A description of the campaign.
        • HoldoutPercent — (Integer) The allocated percentage of end users who will not receive messages from this campaign.
        • Hook — (map) Campaign hook information.
          • LambdaFunctionName — (String) Lambda function name or arn to be called for delivery
          • Mode — (String) What mode Lambda should be invoked in. Possible values include:
            • "DELIVERY"
            • "FILTER"
          • 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 — (map) 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 — (map) The message configuration settings.
          • ADMMessage — (map) 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. Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • 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 — (map) 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. Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • 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 — (map) 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. Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • 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 — (map) 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. Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • 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 — (map) 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 — (map) 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. Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • 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 — (map) The SMS message configuration.
            • Body — (String) The SMS text body.
            • MessageType — (String) Is this is a transactional SMS message, otherwise a promotional message. Possible values include:
              • "TRANSACTIONAL"
              • "PROMOTIONAL"
            • SenderId — (String) Sender ID of sent message.
        • Name — (String) The custom name of the campaign.
        • Schedule — (map) The campaign schedule.
          • EndTime — (String) The scheduled time that the campaign ends in ISO 8601 format.
          • EventFilter — (map) Defines the type of events that can trigger the campaign. Used when the Frequency is set to EVENT.
            • Dimensions — (map) An object that defines the dimensions for the event filter.
              • Attributes — (map<map>) Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
                • 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. Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Values — (Array<String>) 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.
              • EventType — (map) 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. Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Values — (Array<String>) 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.
              • Metrics — (map<map>) Custom metrics that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
                • 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 — (Float) 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. Possible values include:
              • "SYSTEM"
              • "ENDPOINT"
          • Frequency — (String) How often the campaign delivers messages. Valid values: ONCE HOURLY DAILY WEEKLY MONTHLY EVENT Possible values include:
            • "ONCE"
            • "HOURLY"
            • "DAILY"
            • "WEEKLY"
            • "MONTHLY"
            • "EVENT"
          • IsLocalTime — (Boolean) Indicates whether the campaign schedule takes effect according to each user's local time.
          • QuietTime — (map) 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 — (map) 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 Possible values include:
            • "SCHEDULED"
            • "EXECUTING"
            • "PENDING_NEXT_RUN"
            • "COMPLETED"
            • "PAUSED"
            • "DELETED"
        • tags — (map<String>) The Tags for the campaign.
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createExportJob(params = {}, callback) ⇒ AWS.Request

Creates an export job.

Service Reference:

Examples:

Calling the createExportJob operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  ExportJobRequest: { /* required */
    RoleArn: 'STRING_VALUE',
    S3UrlPrefix: 'STRING_VALUE',
    SegmentId: 'STRING_VALUE',
    SegmentVersion: 'NUMBER_VALUE'
  }
};
pinpoint.createExportJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.
    • ExportJobRequest — (map) Export job request.
      • RoleArn — (String) The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that endpoints will be exported to.
      • S3UrlPrefix — (String) A URL that points to the location within an Amazon S3 bucket that will receive the export. The location is typically a folder with multiple files. The URL should follow this format: s3://bucket-name/folder-name/ Amazon Pinpoint will export endpoints to this location.
      • SegmentId — (String) The ID of the segment to export endpoints from. If not present, Amazon Pinpoint exports all of the endpoints that belong to the application.
      • SegmentVersion — (Integer) The version of the segment to export if specified.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ExportJobResponse — (map) Export job response.
        • ApplicationId — (String) The unique ID of the application associated with the export job.
        • CompletedPieces — (Integer) The number of pieces that have successfully completed as of the time of the request.
        • CompletionDate — (String) The date the job completed in ISO 8601 format.
        • CreationDate — (String) The date the job was created in ISO 8601 format.
        • Definition — (map) The export job settings.
          • RoleArn — (String) The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that endpoints will be exported to.
          • S3UrlPrefix — (String) A URL that points to the location within an Amazon S3 bucket that will receive the export. The location is typically a folder with multiple files. The URL should follow this format: s3://bucket-name/folder-name/ Amazon Pinpoint will export endpoints to this location.
          • SegmentId — (String) The ID of the segment to export endpoints from. If not present, Amazon Pinpoint exports all of the endpoints that belong to the application.
          • SegmentVersion — (Integer) The version of the segment to export if specified.
        • FailedPieces — (Integer) The number of pieces that failed to be processed as of the time of the request.
        • Failures — (Array<String>) Provides up to 100 of the first failed entries for the job, if any exist.
        • Id — (String) The unique ID of the job.
        • JobStatus — (String) The status of the job. Valid values: CREATED, INITIALIZING, PROCESSING, COMPLETING, COMPLETED, FAILING, FAILED The job status is FAILED if one or more pieces failed. Possible values include:
          • "CREATED"
          • "INITIALIZING"
          • "PROCESSING"
          • "COMPLETING"
          • "COMPLETED"
          • "FAILING"
          • "FAILED"
        • TotalFailures — (Integer) The number of endpoints that were not processed; for example, because of syntax errors.
        • TotalPieces — (Integer) The total number of pieces that must be processed to finish the job. Each piece is an approximately equal portion of the endpoints.
        • TotalProcessed — (Integer) The number of endpoints that were processed by the job.
        • Type — (String) The job type. Will be 'EXPORT'.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createImportJob(params = {}, callback) ⇒ AWS.Request

Creates or updates an import job.

Service Reference:

Examples:

Calling the createImportJob operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  ImportJobRequest: { /* required */
    DefineSegment: true || false,
    ExternalId: 'STRING_VALUE',
    Format: CSV | JSON,
    RegisterEndpoints: true || false,
    RoleArn: 'STRING_VALUE',
    S3Url: 'STRING_VALUE',
    SegmentId: 'STRING_VALUE',
    SegmentName: 'STRING_VALUE'
  }
};
pinpoint.createImportJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.
    • ImportJobRequest — (map) Import job request.
      • DefineSegment — (Boolean) Sets whether the endpoints create a segment when they are imported.
      • ExternalId — (String) (Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.
      • Format — (String) The format of the files that contain the endpoint definitions. Valid values: CSV, JSON Possible values include:
        • "CSV"
        • "JSON"
      • RegisterEndpoints — (Boolean) Sets whether the endpoints are registered with Amazon Pinpoint when they are imported.
      • RoleArn — (String) The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that contains the endpoints to import.
      • S3Url — (String) The URL of the S3 bucket that contains the segment information to import. The location can be a folder or a single file. The URL should use the following format: s3://bucket-name/folder-name/file-name Amazon Pinpoint imports endpoints from this location and any subfolders it contains.
      • SegmentId — (String) The ID of the segment to update if the import job is meant to update an existing segment.
      • SegmentName — (String) A custom name for the segment created by the import job. Use if DefineSegment is true.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ImportJobResponse — (map) Import job response.
        • ApplicationId — (String) The unique ID of the application to which the import job applies.
        • CompletedPieces — (Integer) The number of pieces that have successfully imported as of the time of the request.
        • CompletionDate — (String) The date the import job completed in ISO 8601 format.
        • CreationDate — (String) The date the import job was created in ISO 8601 format.
        • Definition — (map) The import job settings.
          • DefineSegment — (Boolean) Sets whether the endpoints create a segment when they are imported.
          • ExternalId — (String) (Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.
          • Format — (String) The format of the files that contain the endpoint definitions. Valid values: CSV, JSON Possible values include:
            • "CSV"
            • "JSON"
          • RegisterEndpoints — (Boolean) Sets whether the endpoints are registered with Amazon Pinpoint when they are imported.
          • RoleArn — (String) The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that contains the endpoints to import.
          • S3Url — (String) The URL of the S3 bucket that contains the segment information to import. The location can be a folder or a single file. The URL should use the following format: s3://bucket-name/folder-name/file-name Amazon Pinpoint imports endpoints from this location and any subfolders it contains.
          • SegmentId — (String) The ID of the segment to update if the import job is meant to update an existing segment.
          • SegmentName — (String) A custom name for the segment created by the import job. Use if DefineSegment is true.
        • FailedPieces — (Integer) The number of pieces that have failed to import as of the time of the request.
        • Failures — (Array<String>) Provides up to 100 of the first failed entries for the job, if any exist.
        • Id — (String) The unique ID of the import job.
        • JobStatus — (String) The status of the import job. Valid values: CREATED, INITIALIZING, PROCESSING, COMPLETING, COMPLETED, FAILING, FAILED The job status is FAILED if one or more pieces failed to import. Possible values include:
          • "CREATED"
          • "INITIALIZING"
          • "PROCESSING"
          • "COMPLETING"
          • "COMPLETED"
          • "FAILING"
          • "FAILED"
        • TotalFailures — (Integer) The number of endpoints that failed to import; for example, because of syntax errors.
        • TotalPieces — (Integer) The total number of pieces that must be imported to finish the job. Each piece is an approximately equal portion of the endpoints to import.
        • TotalProcessed — (Integer) The number of endpoints that were processed by the import job.
        • Type — (String) The job type. Will be Import.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createSegment(params = {}, callback) ⇒ AWS.Request

Used to create or update a segment.

Service Reference:

Examples:

Calling the createSegment operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  WriteSegmentRequest: { /* required */
    Dimensions: {
      Attributes: {
        '<__string>': {
          AttributeType: INCLUSIVE | EXCLUSIVE,
          Values: [
            'STRING_VALUE',
            /* more items */
          ]
        },
        /* '<__string>': ... */
      },
      Behavior: {
        Recency: {
          Duration: HR_24 | DAY_7 | DAY_14 | DAY_30,
          RecencyType: ACTIVE | INACTIVE
        }
      },
      Demographic: {
        AppVersion: {
          DimensionType: INCLUSIVE | EXCLUSIVE,
          Values: [
            'STRING_VALUE',
            /* more items */
          ]
        },
        Channel: {
          DimensionType: INCLUSIVE | EXCLUSIVE,
          Values: [
            'STRING_VALUE',
            /* more items */
          ]
        },
        DeviceType: {
          DimensionType: INCLUSIVE | EXCLUSIVE,
          Values: [
            'STRING_VALUE',
            /* more items */
          ]
        },
        Make: {
          DimensionType: INCLUSIVE | EXCLUSIVE,
          Values: [
            'STRING_VALUE',
            /* more items */
          ]
        },
        Model: {
          DimensionType: INCLUSIVE | EXCLUSIVE,
          Values: [
            'STRING_VALUE',
            /* more items */
          ]
        },
        Platform: {
          DimensionType: INCLUSIVE | EXCLUSIVE,
          Values: [
            'STRING_VALUE',
            /* more items */
          ]
        }
      },
      Location: {
        Country: {
          DimensionType: INCLUSIVE | EXCLUSIVE,
          Values: [
            'STRING_VALUE',
            /* more items */
          ]
        },
        GPSPoint: {
          Coordinates: {
            Latitude: 'NUMBER_VALUE',
            Longitude: 'NUMBER_VALUE'
          },
          RangeInKilometers: 'NUMBER_VALUE'
        }
      },
      Metrics: {
        '<__string>': {
          ComparisonOperator: 'STRING_VALUE',
          Value: 'NUMBER_VALUE'
        },
        /* '<__string>': ... */
      },
      UserAttributes: {
        '<__string>': {
          AttributeType: INCLUSIVE | EXCLUSIVE,
          Values: [
            'STRING_VALUE',
            /* more items */
          ]
        },
        /* '<__string>': ... */
      }
    },
    Name: 'STRING_VALUE',
    SegmentGroups: {
      Groups: [
        {
          Dimensions: [
            {
              Attributes: {
                '<__string>': {
                  AttributeType: INCLUSIVE | EXCLUSIVE,
                  Values: [
                    'STRING_VALUE',
                    /* more items */
                  ]
                },
                /* '<__string>': ... */
              },
              Behavior: {
                Recency: {
                  Duration: HR_24 | DAY_7 | DAY_14 | DAY_30,
                  RecencyType: ACTIVE | INACTIVE
                }
              },
              Demographic: {
                AppVersion: {
                  DimensionType: INCLUSIVE | EXCLUSIVE,
                  Values: [
                    'STRING_VALUE',
                    /* more items */
                  ]
                },
                Channel: {
                  DimensionType: INCLUSIVE | EXCLUSIVE,
                  Values: [
                    'STRING_VALUE',
                    /* more items */
                  ]
                },
                DeviceType: {
                  DimensionType: INCLUSIVE | EXCLUSIVE,
                  Values: [
                    'STRING_VALUE',
                    /* more items */
                  ]
                },
                Make: {
                  DimensionType: INCLUSIVE | EXCLUSIVE,
                  Values: [
                    'STRING_VALUE',
                    /* more items */
                  ]
                },
                Model: {
                  DimensionType: INCLUSIVE | EXCLUSIVE,
                  Values: [
                    'STRING_VALUE',
                    /* more items */
                  ]
                },
                Platform: {
                  DimensionType: INCLUSIVE | EXCLUSIVE,
                  Values: [
                    'STRING_VALUE',
                    /* more items */
                  ]
                }
              },
              Location: {
                Country: {
                  DimensionType: INCLUSIVE | EXCLUSIVE,
                  Values: [
                    'STRING_VALUE',
                    /* more items */
                  ]
                },
                GPSPoint: {
                  Coordinates: {
                    Latitude: 'NUMBER_VALUE',
                    Longitude: 'NUMBER_VALUE'
                  },
                  RangeInKilometers: 'NUMBER_VALUE'
                }
              },
              Metrics: {
                '<__string>': {
                  ComparisonOperator: 'STRING_VALUE',
                  Value: 'NUMBER_VALUE'
                },
                /* '<__string>': ... */
              },
              UserAttributes: {
                '<__string>': {
                  AttributeType: INCLUSIVE | EXCLUSIVE,
                  Values: [
                    'STRING_VALUE',
                    /* more items */
                  ]
                },
                /* '<__string>': ... */
              }
            },
            /* more items */
          ],
          SourceSegments: [
            {
              Id: 'STRING_VALUE',
              Version: 'NUMBER_VALUE'
            },
            /* more items */
          ],
          SourceType: ALL | ANY | NONE,
          Type: ALL | ANY | NONE
        },
        /* more items */
      ],
      Include: ALL | ANY | NONE
    },
    tags: {
      '<__string>': 'STRING_VALUE',
      /* '<__string>': ... */
    }
  }
};
pinpoint.createSegment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.
    • WriteSegmentRequest — (map) Segment definition.
      • Dimensions — (map) The segment dimensions attributes.
        • Attributes — (map<map>) Custom segment attributes.
          • 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. Possible values include:
            • "INCLUSIVE"
            • "EXCLUSIVE"
          • Values — (Array<String>) 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.
        • Behavior — (map) The segment behaviors attributes.
          • Recency — (map) The recency of use.
            • Duration — (String) The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30 Possible values include:
              • "HR_24"
              • "DAY_7"
              • "DAY_14"
              • "DAY_30"
            • RecencyType — (String) The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment. Possible values include:
              • "ACTIVE"
              • "INACTIVE"
        • Demographic — (map) The segment demographics attributes.
          • AppVersion — (map) The app version criteria for the segment.
            • 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. Possible values include:
              • "INCLUSIVE"
              • "EXCLUSIVE"
            • Values — (Array<String>) 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.
          • Channel — (map) The channel criteria for the segment.
            • 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. Possible values include:
              • "INCLUSIVE"
              • "EXCLUSIVE"
            • Values — (Array<String>) 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.
          • DeviceType — (map) The device type criteria for the segment.
            • 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. Possible values include:
              • "INCLUSIVE"
              • "EXCLUSIVE"
            • Values — (Array<String>) 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.
          • Make — (map) The device make criteria for the segment.
            • 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. Possible values include:
              • "INCLUSIVE"
              • "EXCLUSIVE"
            • Values — (Array<String>) 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.
          • Model — (map) The device model criteria for the segment.
            • 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. Possible values include:
              • "INCLUSIVE"
              • "EXCLUSIVE"
            • Values — (Array<String>) 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.
          • Platform — (map) The device platform criteria for the segment.
            • 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. Possible values include:
              • "INCLUSIVE"
              • "EXCLUSIVE"
            • Values — (Array<String>) 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.
        • Location — (map) The segment location attributes.
          • Country — (map) The country or region, in ISO 3166-1 alpha-2 format.
            • 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. Possible values include:
              • "INCLUSIVE"
              • "EXCLUSIVE"
            • Values — (Array<String>) 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.
          • GPSPoint — (map) The GPS Point dimension.
            • Coordinates — (map) Coordinate to measure distance from.
              • Latitude — (Float) Latitude
              • Longitude — (Float) Longitude
            • RangeInKilometers — (Float) Range in kilometers from the coordinate.
        • Metrics — (map<map>) Custom segment metrics.
          • 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 — (Float) The value to be compared.
        • UserAttributes — (map<map>) Custom segment user attributes.
          • 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. Possible values include:
            • "INCLUSIVE"
            • "EXCLUSIVE"
          • Values — (Array<String>) 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.
      • Name — (String) The name of segment
      • SegmentGroups — (map) A segment group, which consists of zero or more source segments, plus dimensions that are applied to those source segments. Your request can only include one segment group. Your request can include either a SegmentGroups object or a Dimensions object, but not both.
        • Groups — (Array<map>) A set of segment criteria to evaluate.
          • Dimensions — (Array<map>) List of dimensions to include or exclude.
            • Attributes — (map<map>) Custom segment attributes.
              • 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. Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Values — (Array<String>) 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.
            • Behavior — (map) The segment behaviors attributes.
              • Recency — (map) The recency of use.
                • Duration — (String) The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30 Possible values include:
                  • "HR_24"
                  • "DAY_7"
                  • "DAY_14"
                  • "DAY_30"
                • RecencyType — (String) The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment. Possible values include:
                  • "ACTIVE"
                  • "INACTIVE"
            • Demographic — (map) The segment demographics attributes.
              • AppVersion — (map) The app version criteria for the segment.
                • 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. Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Values — (Array<String>) 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.
              • Channel — (map) The channel criteria for the segment.
                • 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. Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Values — (Array<String>) 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.
              • DeviceType — (map) The device type criteria for the segment.
                • 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. Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Values — (Array<String>) 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.
              • Make — (map) The device make criteria for the segment.
                • 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. Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Values — (Array<String>) 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.
              • Model — (map) The device model criteria for the segment.
                • 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. Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Values — (Array<String>) 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.
              • Platform — (map) The device platform criteria for the segment.
                • 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. Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Values — (Array<String>) 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.
            • Location — (map) The segment location attributes.
              • Country — (map) The country or region, in ISO 3166-1 alpha-2 format.
                • 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. Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Values — (Array<String>) 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.
              • GPSPoint — (map) The GPS Point dimension.
                • Coordinates — (map) Coordinate to measure distance from.
                  • Latitude — (Float) Latitude
                  • Longitude — (Float) Longitude
                • RangeInKilometers — (Float) Range in kilometers from the coordinate.
            • Metrics — (map<map>) Custom segment metrics.
              • 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 — (Float) The value to be compared.
            • UserAttributes — (map<map>) Custom segment user attributes.
              • 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. Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Values — (Array<String>) 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.
          • SourceSegments — (Array<map>) The base segment that you build your segment on. The source segment defines the starting "universe" of endpoints. When you add dimensions to the segment, it filters the source segment based on the dimensions that you specify. You can specify more than one dimensional segment. You can only specify one imported segment. NOTE: If you specify an imported segment for this attribute, the segment size estimate that appears in the Amazon Pinpoint console shows the size of the imported segment, without any filters applied to it.
            • Id — (String) A unique identifier for the segment.
            • Version — (Integer) If specified contains a specific version of the segment included.
          • SourceType — (String) Specify how to handle multiple source segments. For example, if you specify three source segments, should the resulting segment be based on any or all of the segments? Acceptable values: ANY or ALL. Possible values include:
            • "ALL"
            • "ANY"
            • "NONE"
          • Type — (String) Specify how to handle multiple segment dimensions. For example, if you specify three dimensions, should the resulting segment include endpoints that are matched by all, any, or none of the dimensions? Acceptable values: ALL, ANY, or NONE. Possible values include:
            • "ALL"
            • "ANY"
            • "NONE"
        • Include — (String) Specify how to handle multiple segment groups. For example, if the segment includes three segment groups, should the resulting segment include endpoints that are matched by all, any, or none of the segment groups you created. Acceptable values: ALL, ANY, or NONE. Possible values include:
          • "ALL"
          • "ANY"
          • "NONE"
      • tags — (map<String>) The Tags for the segments.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SegmentResponse — (map) Segment definition.
        • ApplicationId — (String) The ID of the application that the segment applies to.
        • Arn — (String) The arn for the segment.
        • CreationDate — (String) The date and time when the segment was created.
        • Dimensions — (map) The segment dimensions attributes.
          • Attributes — (map<map>) Custom segment attributes.
            • 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. Possible values include:
              • "INCLUSIVE"
              • "EXCLUSIVE"
            • Values — (Array<String>) 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.
          • Behavior — (map) The segment behaviors attributes.
            • Recency — (map) The recency of use.
              • Duration — (String) The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30 Possible values include:
                • "HR_24"
                • "DAY_7"
                • "DAY_14"
                • "DAY_30"
              • RecencyType — (String) The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment. Possible values include:
                • "ACTIVE"
                • "INACTIVE"
          • Demographic — (map) The segment demographics attributes.
            • AppVersion — (map) The app version criteria for the segment.
              • 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. Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Values — (Array<String>) 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.
            • Channel — (map) The channel criteria for the segment.
              • 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. Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Values — (Array<String>) 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.
            • DeviceType — (map) The device type criteria for the segment.
              • 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. Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Values — (Array<String>) 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.
            • Make — (map) The device make criteria for the segment.
              • 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. Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Values — (Array<String>) 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.
            • Model — (map) The device model criteria for the segment.
              • 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. Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Values — (Array<String>) 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.
            • Platform — (map) The device platform criteria for the segment.
              • 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. Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Values — (Array<String>) 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.
          • Location — (map) The segment location attributes.
            • Country — (map) The country or region, in ISO 3166-1 alpha-2 format.
              • 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. Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Values — (Array<String>) 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.
            • GPSPoint — (map) The GPS Point dimension.
              • Coordinates — (map) Coordinate to measure distance from.
                • Latitude — (Float) Latitude
                • Longitude — (Float) Longitude
              • RangeInKilometers — (Float) Range in kilometers from the coordinate.
          • Metrics — (map<map>) Custom segment metrics.
            • 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 — (Float) The value to be compared.
          • UserAttributes — (map<map>) Custom segment user attributes.
            • 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. Possible values include:
              • "INCLUSIVE"
              • "EXCLUSIVE"
            • Values — (Array<String>) 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.
        • Id — (String) The unique segment ID.
        • ImportDefinition — (map) The import job settings.
          • ChannelCounts — (map<Integer>) The number of channel types in the imported segment.
          • ExternalId — (String) (Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.
          • Format — (String) The format of the endpoint files that were imported to create this segment. Valid values: CSV, JSON Possible values include:
            • "CSV"
            • "JSON"
          • RoleArn — (String) The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the endpoints in Amazon S3.
          • S3Url — (String) The URL of the S3 bucket that the segment was imported from.
          • Size — (Integer) The number of endpoints that were successfully imported to create this segment.
        • LastModifiedDate — (String) The date and time when the segment was last modified.
        • Name — (String) The name of the segment.
        • SegmentGroups — (map) A segment group, which consists of zero or more source segments, plus dimensions that are applied to those source segments.
          • Groups — (Array<map>) A set of segment criteria to evaluate.
            • Dimensions — (Array<map>) List of dimensions to include or exclude.
              • Attributes — (map<map>) Custom segment attributes.
                • 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. Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Values — (Array<String>) 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.
              • Behavior — (map) The segment behaviors attributes.
                • Recency — (map) The recency of use.
                  • Duration — (String) The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30 Possible values include:
                    • "HR_24"
                    • "DAY_7"
                    • "DAY_14"
                    • "DAY_30"
                  • RecencyType — (String) The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment. Possible values include:
                    • "ACTIVE"
                    • "INACTIVE"
              • Demographic — (map) The segment demographics attributes.
                • AppVersion — (map) The app version criteria for the segment.
                  • 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
                • Channel — (map) The channel criteria for the segment.
                  • 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
                • DeviceType — (map) The device type criteria for the segment.
                  • 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
                • Make — (map) The device make criteria for the segment.
                  • 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
                • Model — (map) The device model criteria for the segment.
                  • 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
                • Platform — (map) The device platform criteria for the segment.
                  • 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
              • Location — (map) The segment location attributes.
                • Country — (map) The country or region, in ISO 3166-1 alpha-2 format.
                  • 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
                • GPSPoint — (map) The GPS Point dimension.
                  • Coordinates — (map) Coordinate to measure distance from.
                    • Latitude — (Float) Latitude
                    • Longitude — (Float) Longitude
                  • RangeInKilometers — (Float) Range in kilometers from the coordinate.
              • Metrics — (map<map>) Custom segment metrics.
                • 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 — (Float) The value to be compared.
              • UserAttributes — (map<map>) Custom segment user attributes.
                • 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. Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Values — (Array<String>) 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.
            • SourceSegments — (Array<map>) The base segment that you build your segment on. The source segment defines the starting "universe" of endpoints. When you add dimensions to the segment, it filters the source segment based on the dimensions that you specify. You can specify more than one dimensional segment. You can only specify one imported segment. NOTE: If you specify an imported segment for this attribute, the segment size estimate that appears in the Amazon Pinpoint console shows the size of the imported segment, without any filters applied to it.
              • Id — (String) A unique identifier for the segment.
              • Version — (Integer) If specified contains a specific version of the segment included.
            • SourceType — (String) Specify how to handle multiple source segments. For example, if you specify three source segments, should the resulting segment be based on any or all of the segments? Acceptable values: ANY or ALL. Possible values include:
              • "ALL"
              • "ANY"
              • "NONE"
            • Type — (String) Specify how to handle multiple segment dimensions. For example, if you specify three dimensions, should the resulting segment include endpoints that are matched by all, any, or none of the dimensions? Acceptable values: ALL, ANY, or NONE. Possible values include:
              • "ALL"
              • "ANY"
              • "NONE"
          • Include — (String) Specify how to handle multiple segment groups. For example, if the segment includes three segment groups, should the resulting segment include endpoints that are matched by all, any, or none of the segment groups you created. Acceptable values: ALL, ANY, or NONE. Possible values include:
            • "ALL"
            • "ANY"
            • "NONE"
        • SegmentType — (String) The segment type: DIMENSIONAL - A dynamic segment built from selection criteria based on endpoint data reported by your app. You create this type of segment by using the segment builder in the Amazon Pinpoint console or by making a POST request to the segments resource. IMPORT - A static segment built from an imported set of endpoint definitions. You create this type of segment by importing a segment in the Amazon Pinpoint console or by making a POST request to the jobs/import resource. Possible values include:
          • "DIMENSIONAL"
          • "IMPORT"
        • tags — (map<String>) The Tags for the segment.
        • Version — (Integer) The segment version number.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteAdmChannel(params = {}, callback) ⇒ AWS.Request

Delete an ADM channel.

Service Reference:

Examples:

Calling the deleteAdmChannel operation

var params = {
  ApplicationId: 'STRING_VALUE' /* required */
};
pinpoint.deleteAdmChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ADMChannelResponse — (map) Amazon Device Messaging channel definition.
        • ApplicationId — (String) The ID of the application to which the channel applies.
        • CreationDate — (String) The date and time when this channel was created.
        • Enabled — (Boolean) Indicates whether or not the channel is enabled for sending messages.
        • HasCredential — (Boolean) Not used. Retained for backwards compatibility.
        • Id — (String) (Deprecated) An identifier for the channel. Retained for backwards compatibility.
        • IsArchived — (Boolean) Indicates whether or not the channel is archived.
        • LastModifiedBy — (String) The user who last updated this channel.
        • LastModifiedDate — (String) The date and time when this channel was last modified.
        • Platform — (String) The platform type. For this channel, the value is always "ADM."
        • Version — (Integer) The channel version.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteApnsChannel(params = {}, callback) ⇒ AWS.Request

Deletes the APNs channel for an app.

Service Reference:

Examples:

Calling the deleteApnsChannel operation

var params = {
  ApplicationId: 'STRING_VALUE' /* required */
};
pinpoint.deleteApnsChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • APNSChannelResponse — (map) Apple Distribution Push Notification Service channel definition.
        • ApplicationId — (String) The ID of the application that the channel applies to.
        • CreationDate — (String) The date and time when this channel was created.
        • DefaultAuthenticationMethod — (String) The default authentication method used for APNs.
        • Enabled — (Boolean) If the channel is enabled for sending messages.
        • HasCredential — (Boolean) Not used. Retained for backwards compatibility.
        • HasTokenKey — (Boolean) Indicates whether the channel is configured with a key for APNs token authentication. Provide a token key by setting the TokenKey attribute.
        • Id — (String) (Deprecated) An identifier for the channel. Retained for backwards compatibility.
        • IsArchived — (Boolean) Indicates whether or not the channel is archived.
        • LastModifiedBy — (String) The user who last updated this channel.
        • LastModifiedDate — (String) The date and time when this channel was last modified.
        • Platform — (String) The platform type. For this channel, the value is always "ADM."
        • Version — (Integer) The channel version.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteApnsSandboxChannel(params = {}, callback) ⇒ AWS.Request

Delete an APNS sandbox channel.

Service Reference:

Examples:

Calling the deleteApnsSandboxChannel operation

var params = {
  ApplicationId: 'STRING_VALUE' /* required */
};
pinpoint.deleteApnsSandboxChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • APNSSandboxChannelResponse — (map) Apple Development Push Notification Service channel definition.
        • ApplicationId — (String) The ID of the application to which the channel applies.
        • CreationDate — (String) When was this segment created
        • DefaultAuthenticationMethod — (String) The default authentication method used for APNs.
        • Enabled — (Boolean) If the channel is enabled for sending messages.
        • HasCredential — (Boolean) Not used. Retained for backwards compatibility.
        • HasTokenKey — (Boolean) Indicates whether the channel is configured with a key for APNs token authentication. Provide a token key by setting the TokenKey attribute.
        • Id — (String) Channel ID. Not used, only for backwards compatibility.
        • IsArchived — (Boolean) Is this channel archived
        • LastModifiedBy — (String) Who last updated this entry
        • LastModifiedDate — (String) Last date this was updated
        • Platform — (String) The platform type. Will be APNS_SANDBOX.
        • Version — (Integer) Version of channel

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteApnsVoipChannel(params = {}, callback) ⇒ AWS.Request

Delete an APNS VoIP channel

Service Reference:

Examples:

Calling the deleteApnsVoipChannel operation

var params = {
  ApplicationId: 'STRING_VALUE' /* required */
};
pinpoint.deleteApnsVoipChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • APNSVoipChannelResponse — (map) Apple VoIP Push Notification Service channel definition.
        • ApplicationId — (String) Application id
        • CreationDate — (String) When was this segment created
        • DefaultAuthenticationMethod — (String) The default authentication method used for APNs.
        • Enabled — (Boolean) If the channel is enabled for sending messages.
        • HasCredential — (Boolean) Not used. Retained for backwards compatibility.
        • HasTokenKey — (Boolean) If the channel is registered with a token key for authentication.
        • Id — (String) Channel ID. Not used, only for backwards compatibility.
        • IsArchived — (Boolean) Is this channel archived
        • LastModifiedBy — (String) Who made the last change
        • LastModifiedDate — (String) Last date this was updated
        • Platform — (String) The platform type. Will be APNS.
        • Version — (Integer) Version of channel

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteApnsVoipSandboxChannel(params = {}, callback) ⇒ AWS.Request

Delete an APNS VoIP sandbox channel

Service Reference:

Examples:

Calling the deleteApnsVoipSandboxChannel operation

var params = {
  ApplicationId: 'STRING_VALUE' /* required */
};
pinpoint.deleteApnsVoipSandboxChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • APNSVoipSandboxChannelResponse — (map) Apple VoIP Developer Push Notification Service channel definition.
        • ApplicationId — (String) Application id
        • CreationDate — (String) When was this segment created
        • DefaultAuthenticationMethod — (String) The default authentication method used for APNs.
        • Enabled — (Boolean) If the channel is enabled for sending messages.
        • HasCredential — (Boolean) Not used. Retained for backwards compatibility.
        • HasTokenKey — (Boolean) If the channel is registered with a token key for authentication.
        • Id — (String) Channel ID. Not used, only for backwards compatibility.
        • IsArchived — (Boolean) Is this channel archived
        • LastModifiedBy — (String) Who made the last change
        • LastModifiedDate — (String) Last date this was updated
        • Platform — (String) The platform type. Will be APNS.
        • Version — (Integer) Version of channel

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteApp(params = {}, callback) ⇒ AWS.Request

Deletes an app.

Service Reference:

Examples:

Calling the deleteApp operation

var params = {
  ApplicationId: 'STRING_VALUE' /* required */
};
pinpoint.deleteApp(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationResponse — (map) Application Response.
        • Arn — (String) The arn for the application.
        • Id — (String) The unique application ID.
        • Name — (String) The display name of the application.
        • tags — (map<String>) The Tags for the application.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteBaiduChannel(params = {}, callback) ⇒ AWS.Request

Delete a BAIDU GCM channel

Service Reference:

Examples:

Calling the deleteBaiduChannel operation

var params = {
  ApplicationId: 'STRING_VALUE' /* required */
};
pinpoint.deleteBaiduChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BaiduChannelResponse — (map) Baidu Cloud Messaging channel definition
        • ApplicationId — (String) Application id
        • CreationDate — (String) When was this segment created
        • Credential — (String) The Baidu API key from Baidu.
        • Enabled — (Boolean) If the channel is enabled for sending messages.
        • HasCredential — (Boolean) Not used. Retained for backwards compatibility.
        • Id — (String) Channel ID. Not used, only for backwards compatibility.
        • IsArchived — (Boolean) Is this channel archived
        • LastModifiedBy — (String) Who made the last change
        • LastModifiedDate — (String) Last date this was updated
        • Platform — (String) The platform type. Will be BAIDU
        • Version — (Integer) Version of channel

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteCampaign(params = {}, callback) ⇒ AWS.Request

Deletes a campaign.

Service Reference:

Examples:

Calling the deleteCampaign operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  CampaignId: 'STRING_VALUE' /* required */
};
pinpoint.deleteCampaign(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.
    • CampaignId — (String) The unique ID of the campaign.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CampaignResponse — (map) Campaign definition
        • AdditionalTreatments — (Array<map>) Treatments that are defined in addition to the default treatment.
          • Id — (String) The unique treatment ID.
          • MessageConfiguration — (map) The message configuration settings.
            • ADMMessage — (map) 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. Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • 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 — (map) 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. Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • 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 — (map) 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. Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • 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 — (map) 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. Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • 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 — (map) 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 — (map) 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. Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • 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 — (map) The SMS message configuration.
              • Body — (String) The SMS text body.
              • MessageType — (String) Is this is a transactional SMS message, otherwise a promotional message. Possible values include:
                • "TRANSACTIONAL"
                • "PROMOTIONAL"
              • SenderId — (String) Sender ID of sent message.
          • Schedule — (map) The campaign schedule.
            • EndTime — (String) The scheduled time that the campaign ends in ISO 8601 format.
            • EventFilter — (map) Defines the type of events that can trigger the campaign. Used when the Frequency is set to EVENT.
              • Dimensions — (map) An object that defines the dimensions for the event filter.
                • Attributes — (map<map>) Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
                  • 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
                • EventType — (map) 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
                • Metrics — (map<map>) Custom metrics that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
                  • 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 — (Float) 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. Possible values include:
                • "SYSTEM"
                • "ENDPOINT"
            • Frequency — (String) How often the campaign delivers messages. Valid values: ONCE HOURLY DAILY WEEKLY MONTHLY EVENT Possible values include:
              • "ONCE"
              • "HOURLY"
              • "DAILY"
              • "WEEKLY"
              • "MONTHLY"
              • "EVENT"
            • IsLocalTime — (Boolean) Indicates whether the campaign schedule takes effect according to each user's local time.
            • QuietTime — (map) 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 — (map) 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 Possible values include:
              • "SCHEDULED"
              • "EXECUTING"
              • "PENDING_NEXT_RUN"
              • "COMPLETED"
              • "PAUSED"
              • "DELETED"
          • 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.
        • Arn — (String) The arn for the campaign.
        • CreationDate — (String) The date the campaign was created in ISO 8601 format.
        • DefaultState — (map) 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 Possible values include:
            • "SCHEDULED"
            • "EXECUTING"
            • "PENDING_NEXT_RUN"
            • "COMPLETED"
            • "PAUSED"
            • "DELETED"
        • Description — (String) A description of the campaign.
        • HoldoutPercent — (Integer) The allocated percentage of end users who will not receive messages from this campaign.
        • Hook — (map) Campaign hook information.
          • LambdaFunctionName — (String) Lambda function name or arn to be called for delivery
          • Mode — (String) What mode Lambda should be invoked in. Possible values include:
            • "DELIVERY"
            • "FILTER"
          • 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 — (map) 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 — (map) The message configuration settings.
          • ADMMessage — (map) 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. Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • 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 — (map) 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. Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • 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 — (map) 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. Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • 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 — (map) 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. Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • 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 — (map) 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 — (map) 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. Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • 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 — (map) The SMS message configuration.
            • Body — (String) The SMS text body.
            • MessageType — (String) Is this is a transactional SMS message, otherwise a promotional message. Possible values include:
              • "TRANSACTIONAL"
              • "PROMOTIONAL"
            • SenderId — (String) Sender ID of sent message.
        • Name — (String) The custom name of the campaign.
        • Schedule — (map) The campaign schedule.
          • EndTime — (String) The scheduled time that the campaign ends in ISO 8601 format.
          • EventFilter — (map) Defines the type of events that can trigger the campaign. Used when the Frequency is set to EVENT.
            • Dimensions — (map) An object that defines the dimensions for the event filter.
              • Attributes — (map<map>) Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
                • 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. Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Values — (Array<String>) 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.
              • EventType — (map) 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. Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Values — (Array<String>) 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.
              • Metrics — (map<map>) Custom metrics that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
                • 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 — (Float) 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. Possible values include:
              • "SYSTEM"
              • "ENDPOINT"
          • Frequency — (String) How often the campaign delivers messages. Valid values: ONCE HOURLY DAILY WEEKLY MONTHLY EVENT Possible values include:
            • "ONCE"
            • "HOURLY"
            • "DAILY"
            • "WEEKLY"
            • "MONTHLY"
            • "EVENT"
          • IsLocalTime — (Boolean) Indicates whether the campaign schedule takes effect according to each user's local time.
          • QuietTime — (map) 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 — (map) 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 Possible values include:
            • "SCHEDULED"
            • "EXECUTING"
            • "PENDING_NEXT_RUN"
            • "COMPLETED"
            • "PAUSED"
            • "DELETED"
        • tags — (map<String>) The Tags for the campaign.
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteEmailChannel(params = {}, callback) ⇒ AWS.Request

Delete an email channel.

Service Reference:

Examples:

Calling the deleteEmailChannel operation

var params = {
  ApplicationId: 'STRING_VALUE' /* required */
};
pinpoint.deleteEmailChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • EmailChannelResponse — (map) Email Channel Response.
        • ApplicationId — (String) The unique ID of the application to which the email channel belongs.
        • ConfigurationSet — (String) The configuration set that you want to use when you send email using the Pinpoint Email API.
        • CreationDate — (String) The date that the settings were last updated in ISO 8601 format.
        • Enabled — (Boolean) If the channel is enabled for sending messages.
        • FromAddress — (String) The email address used to send emails from.
        • HasCredential — (Boolean) Not used. Retained for backwards compatibility.
        • Id — (String) Channel ID. Not used, only for backwards compatibility.
        • Identity — (String) The ARN of an identity verified with SES.
        • IsArchived — (Boolean) Is this channel archived
        • LastModifiedBy — (String) Who last updated this entry
        • LastModifiedDate — (String) Last date this was updated
        • MessagesPerSecond — (Integer) Messages per second that can be sent
        • Platform — (String) Platform type. Will be "EMAIL"
        • RoleArn — (String) The ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion service
        • Version — (Integer) Version of channel

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteEndpoint(params = {}, callback) ⇒ AWS.Request

Deletes an endpoint.

Service Reference:

Examples:

Calling the deleteEndpoint operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  EndpointId: 'STRING_VALUE' /* required */
};
pinpoint.deleteEndpoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.
    • EndpointId — (String) The unique ID of the endpoint.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • EndpointResponse — (map) Endpoint response
        • Address — (String) The address of the endpoint as provided by your push provider. For example, the DeviceToken or RegistrationId.
        • ApplicationId — (String) The ID of the application that is associated with the endpoint.
        • Attributes — (map<Array<String>>) Custom attributes that describe the endpoint by associating a name with an array of values. For example, an attribute named "interests" might have the following values: ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create segments. The Amazon Pinpoint console can't display attribute names that include the following characters: hash/pound sign (#), colon (:), question mark (?), backslash (), and forward slash (/). For this reason, you should avoid using these characters in the names of custom attributes.
        • ChannelType — (String) The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU Possible values include:
          • "GCM"
          • "APNS"
          • "APNS_SANDBOX"
          • "APNS_VOIP"
          • "APNS_VOIP_SANDBOX"
          • "ADM"
          • "SMS"
          • "VOICE"
          • "EMAIL"
          • "BAIDU"
          • "CUSTOM"
        • CohortId — (String) A number from 0-99 that represents the cohort the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an app. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for a campaign.
        • CreationDate — (String) The date and time when the endpoint was created, shown in ISO 8601 format.
        • Demographic — (map) The endpoint demographic attributes.
          • AppVersion — (String) The version of the application associated with the endpoint.
          • Locale — (String) The endpoint locale in the following format: The ISO 639-1 alpha-2 code, followed by an underscore, followed by an ISO 3166-1 alpha-2 value.
          • Make — (String) The manufacturer of the endpoint device, such as Apple or Samsung.
          • Model — (String) The model name or number of the endpoint device, such as iPhone.
          • ModelVersion — (String) The model version of the endpoint device.
          • Platform — (String) The platform of the endpoint device, such as iOS or Android.
          • PlatformVersion — (String) The platform version of the endpoint device.
          • Timezone — (String) The timezone of the endpoint. Specified as a tz database value, such as Americas/Los_Angeles.
        • EffectiveDate — (String) The date and time when the endpoint was last updated, shown in ISO 8601 format.
        • EndpointStatus — (String) Unused.
        • Id — (String) The unique ID that you assigned to the endpoint. The ID should be a globally unique identifier (GUID) to ensure that it doesn't conflict with other endpoint IDs associated with the application.
        • Location — (map) The endpoint location attributes.
          • City — (String) The city where the endpoint is located.
          • Country — (String) The two-letter code for the country or region of the endpoint. Specified as an ISO 3166-1 alpha-2 code, such as "US" for the United States.
          • Latitude — (Float) The latitude of the endpoint location, rounded to one decimal place.
          • Longitude — (Float) The longitude of the endpoint location, rounded to one decimal place.
          • PostalCode — (String) The postal code or zip code of the endpoint.
          • Region — (String) The region of the endpoint location. For example, in the United States, this corresponds to a state.
        • Metrics — (map<Float>) Custom metrics that your app reports to Amazon Pinpoint.
        • OptOut — (String) Indicates whether a user has opted out of receiving messages with one of the following values: ALL - User has opted out of all messages. NONE - Users has not opted out and receives all messages.
        • RequestId — (String) The unique ID for the most recent request to update the endpoint.
        • User — (map) Custom user-specific attributes that your app reports to Amazon Pinpoint.
          • UserAttributes — (map<Array<String>>) Custom attributes that describe the user by associating a name with an array of values. For example, an attribute named "interests" might have the following values: ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create segments. The Amazon Pinpoint console can't display attribute names that include the following characters: hash/pound sign (#), colon (:), question mark (?), backslash (), and forward slash (/). For this reason, you should avoid using these characters in the names of custom attributes.
          • UserId — (String) The unique ID of the user.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteEventStream(params = {}, callback) ⇒ AWS.Request

Deletes the event stream for an app.

Service Reference:

Examples:

Calling the deleteEventStream operation

var params = {
  ApplicationId: 'STRING_VALUE' /* required */
};
pinpoint.deleteEventStream(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • EventStream — (map) Model for an event publishing subscription export.
        • ApplicationId — (String) The ID of the application from which events should be published.
        • DestinationStreamArn — (String) The Amazon Resource Name (ARN) of the Amazon Kinesis stream or Firehose delivery stream to which you want to publish events. Firehose ARN: arn:aws:firehose:REGION:ACCOUNT_ID:deliverystream/STREAM_NAME Kinesis ARN: arn:aws:kinesis:REGION:ACCOUNT_ID:stream/STREAM_NAME
        • ExternalId — (String) (Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.
        • LastModifiedDate — (String) The date the event stream was last updated in ISO 8601 format.
        • LastUpdatedBy — (String) The IAM user who last modified the event stream.
        • RoleArn — (String) The IAM role that authorizes Amazon Pinpoint to publish events to the stream in your account.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteGcmChannel(params = {}, callback) ⇒ AWS.Request

Deletes the GCM channel for an app.

Service Reference:

Examples:

Calling the deleteGcmChannel operation

var params = {
  ApplicationId: 'STRING_VALUE' /* required */
};
pinpoint.deleteGcmChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GCMChannelResponse — (map) Google Cloud Messaging channel definition
        • ApplicationId — (String) The ID of the application to which the channel applies.
        • CreationDate — (String) When was this segment created
        • Credential — (String) The GCM API key from Google.
        • Enabled — (Boolean) If the channel is enabled for sending messages.
        • HasCredential — (Boolean) Not used. Retained for backwards compatibility.
        • Id — (String) Channel ID. Not used. Present only for backwards compatibility.
        • IsArchived — (Boolean) Is this channel archived
        • LastModifiedBy — (String) Who last updated this entry
        • LastModifiedDate — (String) Last date this was updated
        • Platform — (String) The platform type. Will be GCM
        • Version — (Integer) Version of channel

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteSegment(params = {}, callback) ⇒ AWS.Request

Deletes a segment.

Service Reference:

Examples:

Calling the deleteSegment operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  SegmentId: 'STRING_VALUE' /* required */
};
pinpoint.deleteSegment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.
    • SegmentId — (String) The unique ID of the segment.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SegmentResponse — (map) Segment definition.
        • ApplicationId — (String) The ID of the application that the segment applies to.
        • Arn — (String) The arn for the segment.
        • CreationDate — (String) The date and time when the segment was created.
        • Dimensions — (map) The segment dimensions attributes.
          • Attributes — (map<map>) Custom segment attributes.
            • 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. Possible values include:
              • "INCLUSIVE"
              • "EXCLUSIVE"
            • Values — (Array<String>) 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.
          • Behavior — (map) The segment behaviors attributes.
            • Recency — (map) The recency of use.
              • Duration — (String) The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30 Possible values include:
                • "HR_24"
                • "DAY_7"
                • "DAY_14"
                • "DAY_30"
              • RecencyType — (String) The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment. Possible values include:
                • "ACTIVE"
                • "INACTIVE"
          • Demographic — (map) The segment demographics attributes.
            • AppVersion — (map) The app version criteria for the segment.
              • 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. Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Values — (Array<String>) 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.
            • Channel — (map) The channel criteria for the segment.
              • 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. Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Values — (Array<String>) 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.
            • DeviceType — (map) The device type criteria for the segment.
              • 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. Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Values — (Array<String>) 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.
            • Make — (map) The device make criteria for the segment.
              • 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. Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Values — (Array<String>) 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.
            • Model — (map) The device model criteria for the segment.
              • 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. Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Values — (Array<String>) 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.
            • Platform — (map) The device platform criteria for the segment.
              • 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. Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Values — (Array<String>) 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.
          • Location — (map) The segment location attributes.
            • Country — (map) The country or region, in ISO 3166-1 alpha-2 format.
              • 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. Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Values — (Array<String>) 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.
            • GPSPoint — (map) The GPS Point dimension.
              • Coordinates — (map) Coordinate to measure distance from.
                • Latitude — (Float) Latitude
                • Longitude — (Float) Longitude
              • RangeInKilometers — (Float) Range in kilometers from the coordinate.
          • Metrics — (map<map>) Custom segment metrics.
            • 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 — (Float) The value to be compared.
          • UserAttributes — (map<map>) Custom segment user attributes.
            • 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. Possible values include:
              • "INCLUSIVE"
              • "EXCLUSIVE"
            • Values — (Array<String>) 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.
        • Id — (String) The unique segment ID.
        • ImportDefinition — (map) The import job settings.
          • ChannelCounts — (map<Integer>) The number of channel types in the imported segment.
          • ExternalId — (String) (Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.
          • Format — (String) The format of the endpoint files that were imported to create this segment. Valid values: CSV, JSON Possible values include:
            • "CSV"
            • "JSON"
          • RoleArn — (String) The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the endpoints in Amazon S3.
          • S3Url — (String) The URL of the S3 bucket that the segment was imported from.
          • Size — (Integer) The number of endpoints that were successfully imported to create this segment.
        • LastModifiedDate — (String) The date and time when the segment was last modified.
        • Name — (String) The name of the segment.
        • SegmentGroups — (map) A segment group, which consists of zero or more source segments, plus dimensions that are applied to those source segments.
          • Groups — (Array<map>) A set of segment criteria to evaluate.
            • Dimensions — (Array<map>) List of dimensions to include or exclude.
              • Attributes — (map<map>) Custom segment attributes.
                • 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. Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Values — (Array<String>) 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.
              • Behavior — (map) The segment behaviors attributes.
                • Recency — (map) The recency of use.
                  • Duration — (String) The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30 Possible values include:
                    • "HR_24"
                    • "DAY_7"
                    • "DAY_14"
                    • "DAY_30"
                  • RecencyType — (String) The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment. Possible values include:
                    • "ACTIVE"
                    • "INACTIVE"
              • Demographic — (map) The segment demographics attributes.
                • AppVersion — (map) The app version criteria for the segment.
                  • 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
                • Channel — (map) The channel criteria for the segment.
                  • 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
                • DeviceType — (map) The device type criteria for the segment.
                  • 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
                • Make — (map) The device make criteria for the segment.
                  • 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
                • Model — (map) The device model criteria for the segment.
                  • 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
                • Platform — (map) The device platform criteria for the segment.
                  • 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
              • Location — (map) The segment location attributes.
                • Country — (map) The country or region, in ISO 3166-1 alpha-2 format.
                  • 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
                • GPSPoint — (map) The GPS Point dimension.
                  • Coordinates — (map) Coordinate to measure distance from.
                    • Latitude — (Float) Latitude
                    • Longitude — (Float) Longitude
                  • RangeInKilometers — (Float) Range in kilometers from the coordinate.
              • Metrics — (map<map>) Custom segment metrics.
                • 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 — (Float) The value to be compared.
              • UserAttributes — (map<map>) Custom segment user attributes.
                • 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. Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Values — (Array<String>) 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.
            • SourceSegments — (Array<map>) The base segment that you build your segment on. The source segment defines the starting "universe" of endpoints. When you add dimensions to the segment, it filters the source segment based on the dimensions that you specify. You can specify more than one dimensional segment. You can only specify one imported segment. NOTE: If you specify an imported segment for this attribute, the segment size estimate that appears in the Amazon Pinpoint console shows the size of the imported segment, without any filters applied to it.
              • Id — (String) A unique identifier for the segment.
              • Version — (Integer) If specified contains a specific version of the segment included.
            • SourceType — (String) Specify how to handle multiple source segments. For example, if you specify three source segments, should the resulting segment be based on any or all of the segments? Acceptable values: ANY or ALL. Possible values include:
              • "ALL"
              • "ANY"
              • "NONE"
            • Type — (String) Specify how to handle multiple segment dimensions. For example, if you specify three dimensions, should the resulting segment include endpoints that are matched by all, any, or none of the dimensions? Acceptable values: ALL, ANY, or NONE. Possible values include:
              • "ALL"
              • "ANY"
              • "NONE"
          • Include — (String) Specify how to handle multiple segment groups. For example, if the segment includes three segment groups, should the resulting segment include endpoints that are matched by all, any, or none of the segment groups you created. Acceptable values: ALL, ANY, or NONE. Possible values include:
            • "ALL"
            • "ANY"
            • "NONE"
        • SegmentType — (String) The segment type: DIMENSIONAL - A dynamic segment built from selection criteria based on endpoint data reported by your app. You create this type of segment by using the segment builder in the Amazon Pinpoint console or by making a POST request to the segments resource. IMPORT - A static segment built from an imported set of endpoint definitions. You create this type of segment by importing a segment in the Amazon Pinpoint console or by making a POST request to the jobs/import resource. Possible values include:
          • "DIMENSIONAL"
          • "IMPORT"
        • tags — (map<String>) The Tags for the segment.
        • Version — (Integer) The segment version number.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteSmsChannel(params = {}, callback) ⇒ AWS.Request

Delete an SMS channel.

Service Reference:

Examples:

Calling the deleteSmsChannel operation

var params = {
  ApplicationId: 'STRING_VALUE' /* required */
};
pinpoint.deleteSmsChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SMSChannelResponse — (map) SMS Channel Response.
        • ApplicationId — (String) The unique ID of the application to which the SMS channel belongs.
        • CreationDate — (String) The date that the settings were last updated in ISO 8601 format.
        • Enabled — (Boolean) If the channel is enabled for sending messages.
        • HasCredential — (Boolean) Not used. Retained for backwards compatibility.
        • Id — (String) Channel ID. Not used, only for backwards compatibility.
        • IsArchived — (Boolean) Is this channel archived
        • LastModifiedBy — (String) Who last updated this entry
        • LastModifiedDate — (String) Last date this was updated
        • Platform — (String) Platform type. Will be "SMS"
        • PromotionalMessagesPerSecond — (Integer) Promotional messages per second that can be sent
        • SenderId — (String) Sender identifier of your messages.
        • ShortCode — (String) The short code registered with the phone provider.
        • TransactionalMessagesPerSecond — (Integer) Transactional messages per second that can be sent
        • Version — (Integer) Version of channel

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteUserEndpoints(params = {}, callback) ⇒ AWS.Request

Deletes endpoints that are associated with a User ID.

Service Reference:

Examples:

Calling the deleteUserEndpoints operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  UserId: 'STRING_VALUE' /* required */
};
pinpoint.deleteUserEndpoints(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.
    • UserId — (String) The unique ID of the user.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • EndpointsResponse — (map) List of endpoints
        • Item — (Array<map>) The list of endpoints.
          • Address — (String) The address of the endpoint as provided by your push provider. For example, the DeviceToken or RegistrationId.
          • ApplicationId — (String) The ID of the application that is associated with the endpoint.
          • Attributes — (map<Array<String>>) Custom attributes that describe the endpoint by associating a name with an array of values. For example, an attribute named "interests" might have the following values: ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create segments. The Amazon Pinpoint console can't display attribute names that include the following characters: hash/pound sign (#), colon (:), question mark (?), backslash (), and forward slash (/). For this reason, you should avoid using these characters in the names of custom attributes.
          • ChannelType — (String) The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU Possible values include:
            • "GCM"
            • "APNS"
            • "APNS_SANDBOX"
            • "APNS_VOIP"
            • "APNS_VOIP_SANDBOX"
            • "ADM"
            • "SMS"
            • "VOICE"
            • "EMAIL"
            • "BAIDU"
            • "CUSTOM"
          • CohortId — (String) A number from 0-99 that represents the cohort the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an app. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for a campaign.
          • CreationDate — (String) The date and time when the endpoint was created, shown in ISO 8601 format.
          • Demographic — (map) The endpoint demographic attributes.
            • AppVersion — (String) The version of the application associated with the endpoint.
            • Locale — (String) The endpoint locale in the following format: The ISO 639-1 alpha-2 code, followed by an underscore, followed by an ISO 3166-1 alpha-2 value.
            • Make — (String) The manufacturer of the endpoint device, such as Apple or Samsung.
            • Model — (String) The model name or number of the endpoint device, such as iPhone.
            • ModelVersion — (String) The model version of the endpoint device.
            • Platform — (String) The platform of the endpoint device, such as iOS or Android.
            • PlatformVersion — (String) The platform version of the endpoint device.
            • Timezone — (String) The timezone of the endpoint. Specified as a tz database value, such as Americas/Los_Angeles.
          • EffectiveDate — (String) The date and time when the endpoint was last updated, shown in ISO 8601 format.
          • EndpointStatus — (String) Unused.
          • Id — (String) The unique ID that you assigned to the endpoint. The ID should be a globally unique identifier (GUID) to ensure that it doesn't conflict with other endpoint IDs associated with the application.
          • Location — (map) The endpoint location attributes.
            • City — (String) The city where the endpoint is located.
            • Country — (String) The two-letter code for the country or region of the endpoint. Specified as an ISO 3166-1 alpha-2 code, such as "US" for the United States.
            • Latitude — (Float) The latitude of the endpoint location, rounded to one decimal place.
            • Longitude — (Float) The longitude of the endpoint location, rounded to one decimal place.
            • PostalCode — (String) The postal code or zip code of the endpoint.
            • Region — (String) The region of the endpoint location. For example, in the United States, this corresponds to a state.
          • Metrics — (map<Float>) Custom metrics that your app reports to Amazon Pinpoint.
          • OptOut — (String) Indicates whether a user has opted out of receiving messages with one of the following values: ALL - User has opted out of all messages. NONE - Users has not opted out and receives all messages.
          • RequestId — (String) The unique ID for the most recent request to update the endpoint.
          • User — (map) Custom user-specific attributes that your app reports to Amazon Pinpoint.
            • UserAttributes — (map<Array<String>>) Custom attributes that describe the user by associating a name with an array of values. For example, an attribute named "interests" might have the following values: ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create segments. The Amazon Pinpoint console can't display attribute names that include the following characters: hash/pound sign (#), colon (:), question mark (?), backslash (), and forward slash (/). For this reason, you should avoid using these characters in the names of custom attributes.
            • UserId — (String) The unique ID of the user.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteVoiceChannel(params = {}, callback) ⇒ AWS.Request

Delete an Voice channel

Service Reference:

Examples:

Calling the deleteVoiceChannel operation

var params = {
  ApplicationId: 'STRING_VALUE' /* required */
};
pinpoint.deleteVoiceChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • VoiceChannelResponse — (map) Voice Channel Response.
        • ApplicationId — (String) Application id
        • CreationDate — (String) The date that the settings were last updated in ISO 8601 format.
        • Enabled — (Boolean) If the channel is enabled for sending messages.
        • HasCredential — (Boolean)
        • Id — (String) Channel ID. Not used, only for backwards compatibility.
        • IsArchived — (Boolean) Is this channel archived
        • LastModifiedBy — (String) Who made the last change
        • LastModifiedDate — (String) Last date this was updated
        • Platform — (String) Platform type. Will be "Voice"
        • Version — (Integer) Version of channel

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getAdmChannel(params = {}, callback) ⇒ AWS.Request

Get an ADM channel.

Service Reference:

Examples:

Calling the getAdmChannel operation

var params = {
  ApplicationId: 'STRING_VALUE' /* required */
};
pinpoint.getAdmChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ADMChannelResponse — (map) Amazon Device Messaging channel definition.
        • ApplicationId — (String) The ID of the application to which the channel applies.
        • CreationDate — (String) The date and time when this channel was created.
        • Enabled — (Boolean) Indicates whether or not the channel is enabled for sending messages.
        • HasCredential — (Boolean) Not used. Retained for backwards compatibility.
        • Id — (String) (Deprecated) An identifier for the channel. Retained for backwards compatibility.
        • IsArchived — (Boolean) Indicates whether or not the channel is archived.
        • LastModifiedBy — (String) The user who last updated this channel.
        • LastModifiedDate — (String) The date and time when this channel was last modified.
        • Platform — (String) The platform type. For this channel, the value is always "ADM."
        • Version — (Integer) The channel version.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getApnsChannel(params = {}, callback) ⇒ AWS.Request

Returns information about the APNs channel for an app.

Service Reference:

Examples:

Calling the getApnsChannel operation

var params = {
  ApplicationId: 'STRING_VALUE' /* required */
};
pinpoint.getApnsChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • APNSChannelResponse — (map) Apple Distribution Push Notification Service channel definition.
        • ApplicationId — (String) The ID of the application that the channel applies to.
        • CreationDate — (String) The date and time when this channel was created.
        • DefaultAuthenticationMethod — (String) The default authentication method used for APNs.
        • Enabled — (Boolean) If the channel is enabled for sending messages.
        • HasCredential — (Boolean) Not used. Retained for backwards compatibility.
        • HasTokenKey — (Boolean) Indicates whether the channel is configured with a key for APNs token authentication. Provide a token key by setting the TokenKey attribute.
        • Id — (String) (Deprecated) An identifier for the channel. Retained for backwards compatibility.
        • IsArchived — (Boolean) Indicates whether or not the channel is archived.
        • LastModifiedBy — (String) The user who last updated this channel.
        • LastModifiedDate — (String) The date and time when this channel was last modified.
        • Platform — (String) The platform type. For this channel, the value is always "ADM."
        • Version — (Integer) The channel version.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getApnsSandboxChannel(params = {}, callback) ⇒ AWS.Request

Get an APNS sandbox channel.

Service Reference:

Examples:

Calling the getApnsSandboxChannel operation

var params = {
  ApplicationId: 'STRING_VALUE' /* required */
};
pinpoint.getApnsSandboxChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • APNSSandboxChannelResponse — (map) Apple Development Push Notification Service channel definition.
        • ApplicationId — (String) The ID of the application to which the channel applies.
        • CreationDate — (String) When was this segment created
        • DefaultAuthenticationMethod — (String) The default authentication method used for APNs.
        • Enabled — (Boolean) If the channel is enabled for sending messages.
        • HasCredential — (Boolean) Not used. Retained for backwards compatibility.
        • HasTokenKey — (Boolean) Indicates whether the channel is configured with a key for APNs token authentication. Provide a token key by setting the TokenKey attribute.
        • Id — (String) Channel ID. Not used, only for backwards compatibility.
        • IsArchived — (Boolean) Is this channel archived
        • LastModifiedBy — (String) Who last updated this entry
        • LastModifiedDate — (String) Last date this was updated
        • Platform — (String) The platform type. Will be APNS_SANDBOX.
        • Version — (Integer) Version of channel

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getApnsVoipChannel(params = {}, callback) ⇒ AWS.Request

Get an APNS VoIP channel

Service Reference:

Examples:

Calling the getApnsVoipChannel operation

var params = {
  ApplicationId: 'STRING_VALUE' /* required */
};
pinpoint.getApnsVoipChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • APNSVoipChannelResponse — (map) Apple VoIP Push Notification Service channel definition.
        • ApplicationId — (String) Application id
        • CreationDate — (String) When was this segment created
        • DefaultAuthenticationMethod — (String) The default authentication method used for APNs.
        • Enabled — (Boolean) If the channel is enabled for sending messages.
        • HasCredential — (Boolean) Not used. Retained for backwards compatibility.
        • HasTokenKey — (Boolean) If the channel is registered with a token key for authentication.
        • Id — (String) Channel ID. Not used, only for backwards compatibility.
        • IsArchived — (Boolean) Is this channel archived
        • LastModifiedBy — (String) Who made the last change
        • LastModifiedDate — (String) Last date this was updated
        • Platform — (String) The platform type. Will be APNS.
        • Version — (Integer) Version of channel

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getApnsVoipSandboxChannel(params = {}, callback) ⇒ AWS.Request

Get an APNS VoIPSandbox channel

Service Reference:

Examples:

Calling the getApnsVoipSandboxChannel operation

var params = {
  ApplicationId: 'STRING_VALUE' /* required */
};
pinpoint.getApnsVoipSandboxChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • APNSVoipSandboxChannelResponse — (map) Apple VoIP Developer Push Notification Service channel definition.
        • ApplicationId — (String) Application id
        • CreationDate — (String) When was this segment created
        • DefaultAuthenticationMethod — (String) The default authentication method used for APNs.
        • Enabled — (Boolean) If the channel is enabled for sending messages.
        • HasCredential — (Boolean) Not used. Retained for backwards compatibility.
        • HasTokenKey — (Boolean) If the channel is registered with a token key for authentication.
        • Id — (String) Channel ID. Not used, only for backwards compatibility.
        • IsArchived — (Boolean) Is this channel archived
        • LastModifiedBy — (String) Who made the last change
        • LastModifiedDate — (String) Last date this was updated
        • Platform — (String) The platform type. Will be APNS.
        • Version — (Integer) Version of channel

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getApp(params = {}, callback) ⇒ AWS.Request

Returns information about an app.

Service Reference:

Examples:

Calling the getApp operation

var params = {
  ApplicationId: 'STRING_VALUE' /* required */
};
pinpoint.getApp(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationResponse — (map) Application Response.
        • Arn — (String) The arn for the application.
        • Id — (String) The unique application ID.
        • Name — (String) The display name of the application.
        • tags — (map<String>) The Tags for the application.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getApplicationSettings(params = {}, callback) ⇒ AWS.Request

Used to request the settings for an app.

Service Reference:

Examples:

Calling the getApplicationSettings operation

var params = {
  ApplicationId: 'STRING_VALUE' /* required */
};
pinpoint.getApplicationSettings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationSettingsResource — (map) Application settings.
        • ApplicationId — (String) The unique ID for the application.
        • CampaignHook — (map) Default campaign hook.
          • LambdaFunctionName — (String) Lambda function name or arn to be called for delivery
          • Mode — (String) What mode Lambda should be invoked in. Possible values include:
            • "DELIVERY"
            • "FILTER"
          • WebUrl — (String) Web URL to call for hook. If the URL has authentication specified it will be added as authentication to the request
        • LastModifiedDate — (String) The date that the settings were last updated in ISO 8601 format.
        • Limits — (map) The default campaign limits for the app. These limits apply to each campaign for the app, unless the campaign overrides the default with limits of its own.
          • 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.
        • QuietTime — (map) The default quiet time for the app. Campaigns in the app don'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 app. 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 an app to use quiet time, campaigns in that app don'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 app (or campaign, if applicable). - 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 app (or campaign, if applicable). Individual campaigns within the app can have their own quiet time settings, which override the quiet time settings at the app level.
          • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getApps(params = {}, callback) ⇒ AWS.Request

Returns information about your apps.

Service Reference:

Examples:

Calling the getApps operation

var params = {
  PageSize: 'STRING_VALUE',
  Token: 'STRING_VALUE'
};
pinpoint.getApps(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • PageSize — (String) The number of entries you want on each page in the response.
    • Token — (String) The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationsResponse — (map) Get Applications Result.
        • Item — (Array<map>) List of applications returned in this page.
          • Arn — (String) The arn for the application.
          • Id — (String) The unique application ID.
          • Name — (String) The display name of the application.
          • tags — (map<String>) The Tags for the application.
        • NextToken — (String) The string that you use in a subsequent request to get the next page of results in a paginated response.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getBaiduChannel(params = {}, callback) ⇒ AWS.Request

Get a BAIDU GCM channel

Service Reference:

Examples:

Calling the getBaiduChannel operation

var params = {
  ApplicationId: 'STRING_VALUE' /* required */
};
pinpoint.getBaiduChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BaiduChannelResponse — (map) Baidu Cloud Messaging channel definition
        • ApplicationId — (String) Application id
        • CreationDate — (String) When was this segment created
        • Credential — (String) The Baidu API key from Baidu.
        • Enabled — (Boolean) If the channel is enabled for sending messages.
        • HasCredential — (Boolean) Not used. Retained for backwards compatibility.
        • Id — (String) Channel ID. Not used, only for backwards compatibility.
        • IsArchived — (Boolean) Is this channel archived
        • LastModifiedBy — (String) Who made the last change
        • LastModifiedDate — (String) Last date this was updated
        • Platform — (String) The platform type. Will be BAIDU
        • Version — (Integer) Version of channel

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getCampaign(params = {}, callback) ⇒ AWS.Request

Returns information about a campaign.

Service Reference:

Examples:

Calling the getCampaign operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  CampaignId: 'STRING_VALUE' /* required */
};
pinpoint.getCampaign(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.
    • CampaignId — (String) The unique ID of the campaign.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CampaignResponse — (map) Campaign definition
        • AdditionalTreatments — (Array<map>) Treatments that are defined in addition to the default treatment.
          • Id — (String) The unique treatment ID.
          • MessageConfiguration — (map) The message configuration settings.
            • ADMMessage — (map) 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. Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • 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 — (map) 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. Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • 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 — (map) 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. Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • 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 — (map) 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. Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • 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 — (map) 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 — (map) 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. Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • 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 — (map) The SMS message configuration.
              • Body — (String) The SMS text body.
              • MessageType — (String) Is this is a transactional SMS message, otherwise a promotional message. Possible values include:
                • "TRANSACTIONAL"
                • "PROMOTIONAL"
              • SenderId — (String) Sender ID of sent message.
          • Schedule — (map) The campaign schedule.
            • EndTime — (String) The scheduled time that the campaign ends in ISO 8601 format.
            • EventFilter — (map) Defines the type of events that can trigger the campaign. Used when the Frequency is set to EVENT.
              • Dimensions — (map) An object that defines the dimensions for the event filter.
                • Attributes — (map<map>) Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
                  • 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
                • EventType — (map) 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
                • Metrics — (map<map>) Custom metrics that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
                  • 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 — (Float) 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. Possible values include:
                • "SYSTEM"
                • "ENDPOINT"
            • Frequency — (String) How often the campaign delivers messages. Valid values: ONCE HOURLY DAILY WEEKLY MONTHLY EVENT Possible values include:
              • "ONCE"
              • "HOURLY"
              • "DAILY"
              • "WEEKLY"
              • "MONTHLY"
              • "EVENT"
            • IsLocalTime — (Boolean) Indicates whether the campaign schedule takes effect according to each user's local time.
            • QuietTime — (map) 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 — (map) 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 Possible values include:
              • "SCHEDULED"
              • "EXECUTING"
              • "PENDING_NEXT_RUN"
              • "COMPLETED"
              • "PAUSED"
              • "DELETED"
          • 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.
        • Arn — (String) The arn for the campaign.
        • CreationDate — (String) The date the campaign was created in ISO 8601 format.
        • DefaultState — (map) 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 Possible values include:
            • "SCHEDULED"
            • "EXECUTING"
            • "PENDING_NEXT_RUN"
            • "COMPLETED"
            • "PAUSED"
            • "DELETED"
        • Description — (String) A description of the campaign.
        • HoldoutPercent — (Integer) The allocated percentage of end users who will not receive messages from this campaign.
        • Hook — (map) Campaign hook information.
          • LambdaFunctionName — (String) Lambda function name or arn to be called for delivery
          • Mode — (String) What mode Lambda should be invoked in. Possible values include:
            • "DELIVERY"
            • "FILTER"
          • 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 — (map) 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 — (map) The message configuration settings.
          • ADMMessage — (map) 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. Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • 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 — (map) 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. Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • 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 — (map) 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. Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • 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 — (map) 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. Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • 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 — (map) 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 — (map) 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. Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • 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 — (map) The SMS message configuration.
            • Body — (String) The SMS text body.
            • MessageType — (String) Is this is a transactional SMS message, otherwise a promotional message. Possible values include:
              • "TRANSACTIONAL"
              • "PROMOTIONAL"
            • SenderId — (String) Sender ID of sent message.
        • Name — (String) The custom name of the campaign.
        • Schedule — (map) The campaign schedule.
          • EndTime — (String) The scheduled time that the campaign ends in ISO 8601 format.
          • EventFilter — (map) Defines the type of events that can trigger the campaign. Used when the Frequency is set to EVENT.
            • Dimensions — (map) An object that defines the dimensions for the event filter.
              • Attributes — (map<map>) Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
                • 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. Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Values — (Array<String>) 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.
              • EventType — (map) 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. Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Values — (Array<String>) 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.
              • Metrics — (map<map>) Custom metrics that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
                • 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 — (Float) 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. Possible values include:
              • "SYSTEM"
              • "ENDPOINT"
          • Frequency — (String) How often the campaign delivers messages. Valid values: ONCE HOURLY DAILY WEEKLY MONTHLY EVENT Possible values include:
            • "ONCE"
            • "HOURLY"
            • "DAILY"
            • "WEEKLY"
            • "MONTHLY"
            • "EVENT"
          • IsLocalTime — (Boolean) Indicates whether the campaign schedule takes effect according to each user's local time.
          • QuietTime — (map) 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 — (map) 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 Possible values include:
            • "SCHEDULED"
            • "EXECUTING"
            • "PENDING_NEXT_RUN"
            • "COMPLETED"
            • "PAUSED"
            • "DELETED"
        • tags — (map<String>) The Tags for the campaign.
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getCampaignActivities(params = {}, callback) ⇒ AWS.Request

Returns information about the activity performed by a campaign.

Service Reference:

Examples:

Calling the getCampaignActivities operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  CampaignId: 'STRING_VALUE', /* required */
  PageSize: 'STRING_VALUE',
  Token: 'STRING_VALUE'
};
pinpoint.getCampaignActivities(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.
    • CampaignId — (String) The unique ID of the campaign.
    • PageSize — (String) The number of entries you want on each page in the response.
    • Token — (String) The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ActivitiesResponse — (map) Activities for campaign.
        • Item — (Array<map>) List of campaign activities
          • ApplicationId — (String) The ID of the application to which the campaign applies.
          • CampaignId — (String) The ID of the campaign to which the activity applies.
          • End — (String) The actual time the activity was marked CANCELLED or COMPLETED. Provided in ISO 8601 format.
          • Id — (String) The unique activity ID.
          • Result — (String) Indicates whether the activity succeeded. Valid values: SUCCESS, FAIL
          • ScheduledStart — (String) The scheduled start time for the activity in ISO 8601 format.
          • Start — (String) The actual start time of the activity in ISO 8601 format.
          • State — (String) The state of the activity. Valid values: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, COMPLETED
          • SuccessfulEndpointCount — (Integer) The total number of endpoints to which the campaign successfully delivered messages.
          • TimezonesCompletedCount — (Integer) The total number of timezones completed.
          • TimezonesTotalCount — (Integer) The total number of unique timezones present in the segment.
          • TotalEndpointCount — (Integer) The total number of endpoints to which the campaign attempts to deliver messages.
          • TreatmentId — (String) The ID of a variation of the campaign used for A/B testing.
        • NextToken — (String) The string that you use in a subsequent request to get the next page of results in a paginated response.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getCampaigns(params = {}, callback) ⇒ AWS.Request

Returns information about your campaigns.

Service Reference:

Examples:

Calling the getCampaigns operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  PageSize: 'STRING_VALUE',
  Token: 'STRING_VALUE'
};
pinpoint.getCampaigns(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.
    • PageSize — (String) The number of entries you want on each page in the response.
    • Token — (String) The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CampaignsResponse — (map) List of available campaigns.
        • Item — (Array<map>) A list of campaigns.
          • AdditionalTreatments — (Array<map>) Treatments that are defined in addition to the default treatment.
            • Id — (String) The unique treatment ID.
            • MessageConfiguration — (map) The message configuration settings.
              • ADMMessage — (map) 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. Possible values include:
                  • "OPEN_APP"
                  • "DEEP_LINK"
                  • "URL"
                • 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 — (map) 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. Possible values include:
                  • "OPEN_APP"
                  • "DEEP_LINK"
                  • "URL"
                • 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 — (map) 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. Possible values include:
                  • "OPEN_APP"
                  • "DEEP_LINK"
                  • "URL"
                • 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 — (map) 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. Possible values include:
                  • "OPEN_APP"
                  • "DEEP_LINK"
                  • "URL"
                • 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 — (map) 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 — (map) 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. Possible values include:
                  • "OPEN_APP"
                  • "DEEP_LINK"
                  • "URL"
                • 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 — (map) The SMS message configuration.
                • Body — (String) The SMS text body.
                • MessageType — (String) Is this is a transactional SMS message, otherwise a promotional message. Possible values include:
                  • "TRANSACTIONAL"
                  • "PROMOTIONAL"
                • SenderId — (String) Sender ID of sent message.
            • Schedule — (map) The campaign schedule.
              • EndTime — (String) The scheduled time that the campaign ends in ISO 8601 format.
              • EventFilter — (map) Defines the type of events that can trigger the campaign. Used when the Frequency is set to EVENT.
                • Dimensions — (map) An object that defines the dimensions for the event filter.
                  • Attributes — (map<map>) Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
                    • 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. Possible values include:
                      • "INCLUSIVE"
                      • "EXCLUSIVE"
                    • Values — (Array<String>) 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.
                  • EventType — (map) 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. Possible values include:
                      • "INCLUSIVE"
                      • "EXCLUSIVE"
                    • Values — (Array<String>) 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.
                  • Metrics — (map<map>) Custom metrics that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
                    • 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 — (Float) 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. Possible values include:
                  • "SYSTEM"
                  • "ENDPOINT"
              • Frequency — (String) How often the campaign delivers messages. Valid values: ONCE HOURLY DAILY WEEKLY MONTHLY EVENT Possible values include:
                • "ONCE"
                • "HOURLY"
                • "DAILY"
                • "WEEKLY"
                • "MONTHLY"
                • "EVENT"
              • IsLocalTime — (Boolean) Indicates whether the campaign schedule takes effect according to each user's local time.
              • QuietTime — (map) 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 — (map) 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 Possible values include:
                • "SCHEDULED"
                • "EXECUTING"
                • "PENDING_NEXT_RUN"
                • "COMPLETED"
                • "PAUSED"
                • "DELETED"
            • 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.
          • Arn — (String) The arn for the campaign.
          • CreationDate — (String) The date the campaign was created in ISO 8601 format.
          • DefaultState — (map) 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 Possible values include:
              • "SCHEDULED"
              • "EXECUTING"
              • "PENDING_NEXT_RUN"
              • "COMPLETED"
              • "PAUSED"
              • "DELETED"
          • Description — (String) A description of the campaign.
          • HoldoutPercent — (Integer) The allocated percentage of end users who will not receive messages from this campaign.
          • Hook — (map) Campaign hook information.
            • LambdaFunctionName — (String) Lambda function name or arn to be called for delivery
            • Mode — (String) What mode Lambda should be invoked in. Possible values include:
              • "DELIVERY"
              • "FILTER"
            • 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 — (map) 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 — (map) The message configuration settings.
            • ADMMessage — (map) 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. Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • 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 — (map) 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. Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • 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 — (map) 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. Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • 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 — (map) 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. Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • 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 — (map) 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 — (map) 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. Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • 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 — (map) The SMS message configuration.
              • Body — (String) The SMS text body.
              • MessageType — (String) Is this is a transactional SMS message, otherwise a promotional message. Possible values include:
                • "TRANSACTIONAL"
                • "PROMOTIONAL"
              • SenderId — (String) Sender ID of sent message.
          • Name — (String) The custom name of the campaign.
          • Schedule — (map) The campaign schedule.
            • EndTime — (String) The scheduled time that the campaign ends in ISO 8601 format.
            • EventFilter — (map) Defines the type of events that can trigger the campaign. Used when the Frequency is set to EVENT.
              • Dimensions — (map) An object that defines the dimensions for the event filter.
                • Attributes — (map<map>) Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
                  • 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
                • EventType — (map) 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
                • Metrics — (map<map>) Custom metrics that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
                  • 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 — (Float) 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. Possible values include:
                • "SYSTEM"
                • "ENDPOINT"
            • Frequency — (String) How often the campaign delivers messages. Valid values: ONCE HOURLY DAILY WEEKLY MONTHLY EVENT Possible values include:
              • "ONCE"
              • "HOURLY"
              • "DAILY"
              • "WEEKLY"
              • "MONTHLY"
              • "EVENT"
            • IsLocalTime — (Boolean) Indicates whether the campaign schedule takes effect according to each user's local time.
            • QuietTime — (map) 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 — (map) 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 Possible values include:
              • "SCHEDULED"
              • "EXECUTING"
              • "PENDING_NEXT_RUN"
              • "COMPLETED"
              • "PAUSED"
              • "DELETED"
          • tags — (map<String>) The Tags for the campaign.
          • 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.
        • NextToken — (String) The string that you use in a subsequent request to get the next page of results in a paginated response.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getCampaignVersion(params = {}, callback) ⇒ AWS.Request

Returns information about a specific version of a campaign.

Service Reference:

Examples:

Calling the getCampaignVersion operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  CampaignId: 'STRING_VALUE', /* required */
  Version: 'STRING_VALUE' /* required */
};
pinpoint.getCampaignVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.
    • CampaignId — (String) The unique ID of the campaign.
    • Version — (String) The version of the campaign.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CampaignResponse — (map) Campaign definition
        • AdditionalTreatments — (Array<map>) Treatments that are defined in addition to the default treatment.
          • Id — (String) The unique treatment ID.
          • MessageConfiguration — (map) The message configuration settings.
            • ADMMessage — (map) 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. Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • 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 — (map) 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. Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • 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 — (map) 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. Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • 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 — (map) 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. Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • 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 — (map) 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 — (map) 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. Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • 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 — (map) The SMS message configuration.
              • Body — (String) The SMS text body.
              • MessageType — (String) Is this is a transactional SMS message, otherwise a promotional message. Possible values include:
                • "TRANSACTIONAL"
                • "PROMOTIONAL"
              • SenderId — (String) Sender ID of sent message.
          • Schedule — (map) The campaign schedule.
            • EndTime — (String) The scheduled time that the campaign ends in ISO 8601 format.
            • EventFilter — (map) Defines the type of events that can trigger the campaign. Used when the Frequency is set to EVENT.
              • Dimensions — (map) An object that defines the dimensions for the event filter.
                • Attributes — (map<map>) Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
                  • 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
                • EventType — (map) 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
                • Metrics — (map<map>) Custom metrics that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
                  • 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 — (Float) 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. Possible values include:
                • "SYSTEM"
                • "ENDPOINT"
            • Frequency — (String) How often the campaign delivers messages. Valid values: ONCE HOURLY DAILY WEEKLY MONTHLY EVENT Possible values include:
              • "ONCE"
              • "HOURLY"
              • "DAILY"
              • "WEEKLY"
              • "MONTHLY"
              • "EVENT"
            • IsLocalTime — (Boolean) Indicates whether the campaign schedule takes effect according to each user's local time.
            • QuietTime — (map) 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 — (map) 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 Possible values include:
              • "SCHEDULED"
              • "EXECUTING"
              • "PENDING_NEXT_RUN"
              • "COMPLETED"
              • "PAUSED"
              • "DELETED"
          • 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.
        • Arn — (String) The arn for the campaign.
        • CreationDate — (String) The date the campaign was created in ISO 8601 format.
        • DefaultState — (map) 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 Possible values include:
            • "SCHEDULED"
            • "EXECUTING"
            • "PENDING_NEXT_RUN"
            • "COMPLETED"
            • "PAUSED"
            • "DELETED"
        • Description — (String) A description of the campaign.
        • HoldoutPercent — (Integer) The allocated percentage of end users who will not receive messages from this campaign.
        • Hook — (map) Campaign hook information.
          • LambdaFunctionName — (String) Lambda function name or arn to be called for delivery
          • Mode — (String) What mode Lambda should be invoked in. Possible values include:
            • "DELIVERY"
            • "FILTER"
          • 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 — (map) 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 — (map) The message configuration settings.
          • ADMMessage — (map) 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. Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • 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 — (map) 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. Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • 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 — (map) 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. Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • 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 — (map) 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. Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • 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 — (map) 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 — (map) 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. Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • 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 — (map) The SMS message configuration.
            • Body — (String) The SMS text body.
            • MessageType — (String) Is this is a transactional SMS message, otherwise a promotional message. Possible values include:
              • "TRANSACTIONAL"
              • "PROMOTIONAL"
            • SenderId — (String) Sender ID of sent message.
        • Name — (String) The custom name of the campaign.
        • Schedule — (map) The campaign schedule.
          • EndTime — (String) The scheduled time that the campaign ends in ISO 8601 format.
          • EventFilter — (map) Defines the type of events that can trigger the campaign. Used when the Frequency is set to EVENT.
            • Dimensions — (map) An object that defines the dimensions for the event filter.
              • Attributes — (map<map>) Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
                • 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. Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Values — (Array<String>) 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.
              • EventType — (map) 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. Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Values — (Array<String>) 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.
              • Metrics — (map<map>) Custom metrics that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
                • 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 — (Float) 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. Possible values include:
              • "SYSTEM"
              • "ENDPOINT"
          • Frequency — (String) How often the campaign delivers messages. Valid values: ONCE HOURLY DAILY WEEKLY MONTHLY EVENT Possible values include:
            • "ONCE"
            • "HOURLY"
            • "DAILY"
            • "WEEKLY"
            • "MONTHLY"
            • "EVENT"
          • IsLocalTime — (Boolean) Indicates whether the campaign schedule takes effect according to each user's local time.
          • QuietTime — (map) 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 — (map) 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 Possible values include:
            • "SCHEDULED"
            • "EXECUTING"
            • "PENDING_NEXT_RUN"
            • "COMPLETED"
            • "PAUSED"
            • "DELETED"
        • tags — (map<String>) The Tags for the campaign.
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getCampaignVersions(params = {}, callback) ⇒ AWS.Request

Returns information about your campaign versions.

Service Reference:

Examples:

Calling the getCampaignVersions operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  CampaignId: 'STRING_VALUE', /* required */
  PageSize: 'STRING_VALUE',
  Token: 'STRING_VALUE'
};
pinpoint.getCampaignVersions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.
    • CampaignId — (String) The unique ID of the campaign.
    • PageSize — (String) The number of entries you want on each page in the response.
    • Token — (String) The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CampaignsResponse — (map) List of available campaigns.
        • Item — (Array<map>) A list of campaigns.
          • AdditionalTreatments — (Array<map>) Treatments that are defined in addition to the default treatment.
            • Id — (String) The unique treatment ID.
            • MessageConfiguration — (map) The message configuration settings.
              • ADMMessage — (map) 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. Possible values include:
                  • "OPEN_APP"
                  • "DEEP_LINK"
                  • "URL"
                • 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 — (map) 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. Possible values include:
                  • "OPEN_APP"
                  • "DEEP_LINK"
                  • "URL"
                • 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 — (map) 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. Possible values include:
                  • "OPEN_APP"
                  • "DEEP_LINK"
                  • "URL"
                • 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 — (map) 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. Possible values include:
                  • "OPEN_APP"
                  • "DEEP_LINK"
                  • "URL"
                • 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 — (map) 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 — (map) 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. Possible values include:
                  • "OPEN_APP"
                  • "DEEP_LINK"
                  • "URL"
                • 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 — (map) The SMS message configuration.
                • Body — (String) The SMS text body.
                • MessageType — (String) Is this is a transactional SMS message, otherwise a promotional message. Possible values include:
                  • "TRANSACTIONAL"
                  • "PROMOTIONAL"
                • SenderId — (String) Sender ID of sent message.
            • Schedule — (map) The campaign schedule.
              • EndTime — (String) The scheduled time that the campaign ends in ISO 8601 format.
              • EventFilter — (map) Defines the type of events that can trigger the campaign. Used when the Frequency is set to EVENT.
                • Dimensions — (map) An object that defines the dimensions for the event filter.
                  • Attributes — (map<map>) Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
                    • 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. Possible values include:
                      • "INCLUSIVE"
                      • "EXCLUSIVE"
                    • Values — (Array<String>) 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.
                  • EventType — (map) 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. Possible values include:
                      • "INCLUSIVE"
                      • "EXCLUSIVE"
                    • Values — (Array<String>) 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.
                  • Metrics — (map<map>) Custom metrics that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
                    • 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 — (Float) 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. Possible values include:
                  • "SYSTEM"
                  • "ENDPOINT"
              • Frequency — (String) How often the campaign delivers messages. Valid values: ONCE HOURLY DAILY WEEKLY MONTHLY EVENT Possible values include:
                • "ONCE"
                • "HOURLY"
                • "DAILY"
                • "WEEKLY"
                • "MONTHLY"
                • "EVENT"
              • IsLocalTime — (Boolean) Indicates whether the campaign schedule takes effect according to each user's local time.
              • QuietTime — (map) 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 — (map) 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 Possible values include:
                • "SCHEDULED"
                • "EXECUTING"
                • "PENDING_NEXT_RUN"
                • "COMPLETED"
                • "PAUSED"
                • "DELETED"
            • 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.
          • Arn — (String) The arn for the campaign.
          • CreationDate — (String) The date the campaign was created in ISO 8601 format.
          • DefaultState — (map) 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 Possible values include:
              • "SCHEDULED"
              • "EXECUTING"
              • "PENDING_NEXT_RUN"
              • "COMPLETED"
              • "PAUSED"
              • "DELETED"
          • Description — (String) A description of the campaign.
          • HoldoutPercent — (Integer) The allocated percentage of end users who will not receive messages from this campaign.
          • Hook — (map) Campaign hook information.
            • LambdaFunctionName — (String) Lambda function name or arn to be called for delivery
            • Mode — (String) What mode Lambda should be invoked in. Possible values include:
              • "DELIVERY"
              • "FILTER"
            • 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 — (map) 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 — (map) The message configuration settings.
            • ADMMessage — (map) 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. Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • 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 — (map) 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. Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • 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 — (map) 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. Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • 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 — (map) 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. Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • 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 — (map) 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 — (map) 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. Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • 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 — (map) The SMS message configuration.
              • Body — (String) The SMS text body.
              • MessageType — (String) Is this is a transactional SMS message, otherwise a promotional message. Possible values include:
                • "TRANSACTIONAL"
                • "PROMOTIONAL"
              • SenderId — (String) Sender ID of sent message.
          • Name — (String) The custom name of the campaign.
          • Schedule — (map) The campaign schedule.
            • EndTime — (String) The scheduled time that the campaign ends in ISO 8601 format.
            • EventFilter — (map) Defines the type of events that can trigger the campaign. Used when the Frequency is set to EVENT.
              • Dimensions — (map) An object that defines the dimensions for the event filter.
                • Attributes — (map<map>) Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
                  • 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
                • EventType — (map) 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
                • Metrics — (map<map>) Custom metrics that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
                  • 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 — (Float) 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. Possible values include:
                • "SYSTEM"
                • "ENDPOINT"
            • Frequency — (String) How often the campaign delivers messages. Valid values: ONCE HOURLY DAILY WEEKLY MONTHLY EVENT Possible values include:
              • "ONCE"
              • "HOURLY"
              • "DAILY"
              • "WEEKLY"
              • "MONTHLY"
              • "EVENT"
            • IsLocalTime — (Boolean) Indicates whether the campaign schedule takes effect according to each user's local time.
            • QuietTime — (map) 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 — (map) 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 Possible values include:
              • "SCHEDULED"
              • "EXECUTING"
              • "PENDING_NEXT_RUN"
              • "COMPLETED"
              • "PAUSED"
              • "DELETED"
          • tags — (map<String>) The Tags for the campaign.
          • 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.
        • NextToken — (String) The string that you use in a subsequent request to get the next page of results in a paginated response.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getChannels(params = {}, callback) ⇒ AWS.Request

Get all channels.

Service Reference:

Examples:

Calling the getChannels operation

var params = {
  ApplicationId: 'STRING_VALUE' /* required */
};
pinpoint.getChannels(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ChannelsResponse — (map) Get channels definition
        • Channels — (map<map>) A map of channels, with the ChannelType as the key and the Channel as the value.
          • ApplicationId — (String) Application id
          • CreationDate — (String) When was this segment created
          • Enabled — (Boolean) If the channel is enabled for sending messages.
          • HasCredential — (Boolean) Not used. Retained for backwards compatibility.
          • Id — (String) Channel ID. Not used, only for backwards compatibility.
          • IsArchived — (Boolean) Is this channel archived
          • LastModifiedBy — (String) Who made the last change
          • LastModifiedDate — (String) Last date this was updated
          • Version — (Integer) Version of channel

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getEmailChannel(params = {}, callback) ⇒ AWS.Request

Get an email channel.

Service Reference:

Examples:

Calling the getEmailChannel operation

var params = {
  ApplicationId: 'STRING_VALUE' /* required */
};
pinpoint.getEmailChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • EmailChannelResponse — (map) Email Channel Response.
        • ApplicationId — (String) The unique ID of the application to which the email channel belongs.
        • ConfigurationSet — (String) The configuration set that you want to use when you send email using the Pinpoint Email API.
        • CreationDate — (String) The date that the settings were last updated in ISO 8601 format.
        • Enabled — (Boolean) If the channel is enabled for sending messages.
        • FromAddress — (String) The email address used to send emails from.
        • HasCredential — (Boolean) Not used. Retained for backwards compatibility.
        • Id — (String) Channel ID. Not used, only for backwards compatibility.
        • Identity — (String) The ARN of an identity verified with SES.
        • IsArchived — (Boolean) Is this channel archived
        • LastModifiedBy — (String) Who last updated this entry
        • LastModifiedDate — (String) Last date this was updated
        • MessagesPerSecond — (Integer) Messages per second that can be sent
        • Platform — (String) Platform type. Will be "EMAIL"
        • RoleArn — (String) The ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion service
        • Version — (Integer) Version of channel

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getEndpoint(params = {}, callback) ⇒ AWS.Request

Returns information about an endpoint.

Service Reference:

Examples:

Calling the getEndpoint operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  EndpointId: 'STRING_VALUE' /* required */
};
pinpoint.getEndpoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.
    • EndpointId — (String) The unique ID of the endpoint.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • EndpointResponse — (map) Endpoint response
        • Address — (String) The address of the endpoint as provided by your push provider. For example, the DeviceToken or RegistrationId.
        • ApplicationId — (String) The ID of the application that is associated with the endpoint.
        • Attributes — (map<Array<String>>) Custom attributes that describe the endpoint by associating a name with an array of values. For example, an attribute named "interests" might have the following values: ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create segments. The Amazon Pinpoint console can't display attribute names that include the following characters: hash/pound sign (#), colon (:), question mark (?), backslash (), and forward slash (/). For this reason, you should avoid using these characters in the names of custom attributes.
        • ChannelType — (String) The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU Possible values include:
          • "GCM"
          • "APNS"
          • "APNS_SANDBOX"
          • "APNS_VOIP"
          • "APNS_VOIP_SANDBOX"
          • "ADM"
          • "SMS"
          • "VOICE"
          • "EMAIL"
          • "BAIDU"
          • "CUSTOM"
        • CohortId — (String) A number from 0-99 that represents the cohort the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an app. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for a campaign.
        • CreationDate — (String) The date and time when the endpoint was created, shown in ISO 8601 format.
        • Demographic — (map) The endpoint demographic attributes.
          • AppVersion — (String) The version of the application associated with the endpoint.
          • Locale — (String) The endpoint locale in the following format: The ISO 639-1 alpha-2 code, followed by an underscore, followed by an ISO 3166-1 alpha-2 value.
          • Make — (String) The manufacturer of the endpoint device, such as Apple or Samsung.
          • Model — (String) The model name or number of the endpoint device, such as iPhone.
          • ModelVersion — (String) The model version of the endpoint device.
          • Platform — (String) The platform of the endpoint device, such as iOS or Android.
          • PlatformVersion — (String) The platform version of the endpoint device.
          • Timezone — (String) The timezone of the endpoint. Specified as a tz database value, such as Americas/Los_Angeles.
        • EffectiveDate — (String) The date and time when the endpoint was last updated, shown in ISO 8601 format.
        • EndpointStatus — (String) Unused.
        • Id — (String) The unique ID that you assigned to the endpoint. The ID should be a globally unique identifier (GUID) to ensure that it doesn't conflict with other endpoint IDs associated with the application.
        • Location — (map) The endpoint location attributes.
          • City — (String) The city where the endpoint is located.
          • Country — (String) The two-letter code for the country or region of the endpoint. Specified as an ISO 3166-1 alpha-2 code, such as "US" for the United States.
          • Latitude — (Float) The latitude of the endpoint location, rounded to one decimal place.
          • Longitude — (Float) The longitude of the endpoint location, rounded to one decimal place.
          • PostalCode — (String) The postal code or zip code of the endpoint.
          • Region — (String) The region of the endpoint location. For example, in the United States, this corresponds to a state.
        • Metrics — (map<Float>) Custom metrics that your app reports to Amazon Pinpoint.
        • OptOut — (String) Indicates whether a user has opted out of receiving messages with one of the following values: ALL - User has opted out of all messages. NONE - Users has not opted out and receives all messages.
        • RequestId — (String) The unique ID for the most recent request to update the endpoint.
        • User — (map) Custom user-specific attributes that your app reports to Amazon Pinpoint.
          • UserAttributes — (map<Array<String>>) Custom attributes that describe the user by associating a name with an array of values. For example, an attribute named "interests" might have the following values: ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create segments. The Amazon Pinpoint console can't display attribute names that include the following characters: hash/pound sign (#), colon (:), question mark (?), backslash (), and forward slash (/). For this reason, you should avoid using these characters in the names of custom attributes.
          • UserId — (String) The unique ID of the user.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getEventStream(params = {}, callback) ⇒ AWS.Request

Returns the event stream for an app.

Service Reference:

Examples:

Calling the getEventStream operation

var params = {
  ApplicationId: 'STRING_VALUE' /* required */
};
pinpoint.getEventStream(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • EventStream — (map) Model for an event publishing subscription export.
        • ApplicationId — (String) The ID of the application from which events should be published.
        • DestinationStreamArn — (String) The Amazon Resource Name (ARN) of the Amazon Kinesis stream or Firehose delivery stream to which you want to publish events. Firehose ARN: arn:aws:firehose:REGION:ACCOUNT_ID:deliverystream/STREAM_NAME Kinesis ARN: arn:aws:kinesis:REGION:ACCOUNT_ID:stream/STREAM_NAME
        • ExternalId — (String) (Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.
        • LastModifiedDate — (String) The date the event stream was last updated in ISO 8601 format.
        • LastUpdatedBy — (String) The IAM user who last modified the event stream.
        • RoleArn — (String) The IAM role that authorizes Amazon Pinpoint to publish events to the stream in your account.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getExportJob(params = {}, callback) ⇒ AWS.Request

Returns information about an export job.

Service Reference:

Examples:

Calling the getExportJob operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  JobId: 'STRING_VALUE' /* required */
};
pinpoint.getExportJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.
    • JobId — (String) The unique ID of the job.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ExportJobResponse — (map) Export job response.
        • ApplicationId — (String) The unique ID of the application associated with the export job.
        • CompletedPieces — (Integer) The number of pieces that have successfully completed as of the time of the request.
        • CompletionDate — (String) The date the job completed in ISO 8601 format.
        • CreationDate — (String) The date the job was created in ISO 8601 format.
        • Definition — (map) The export job settings.
          • RoleArn — (String) The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that endpoints will be exported to.
          • S3UrlPrefix — (String) A URL that points to the location within an Amazon S3 bucket that will receive the export. The location is typically a folder with multiple files. The URL should follow this format: s3://bucket-name/folder-name/ Amazon Pinpoint will export endpoints to this location.
          • SegmentId — (String) The ID of the segment to export endpoints from. If not present, Amazon Pinpoint exports all of the endpoints that belong to the application.
          • SegmentVersion — (Integer) The version of the segment to export if specified.
        • FailedPieces — (Integer) The number of pieces that failed to be processed as of the time of the request.
        • Failures — (Array<String>) Provides up to 100 of the first failed entries for the job, if any exist.
        • Id — (String) The unique ID of the job.
        • JobStatus — (String) The status of the job. Valid values: CREATED, INITIALIZING, PROCESSING, COMPLETING, COMPLETED, FAILING, FAILED The job status is FAILED if one or more pieces failed. Possible values include:
          • "CREATED"
          • "INITIALIZING"
          • "PROCESSING"
          • "COMPLETING"
          • "COMPLETED"
          • "FAILING"
          • "FAILED"
        • TotalFailures — (Integer) The number of endpoints that were not processed; for example, because of syntax errors.
        • TotalPieces — (Integer) The total number of pieces that must be processed to finish the job. Each piece is an approximately equal portion of the endpoints.
        • TotalProcessed — (Integer) The number of endpoints that were processed by the job.
        • Type — (String) The job type. Will be 'EXPORT'.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getExportJobs(params = {}, callback) ⇒ AWS.Request

Returns information about your export jobs.

Service Reference:

Examples:

Calling the getExportJobs operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  PageSize: 'STRING_VALUE',
  Token: 'STRING_VALUE'
};
pinpoint.getExportJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.
    • PageSize — (String) The number of entries you want on each page in the response.
    • Token — (String) The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ExportJobsResponse — (map) Export job list.
        • Item — (Array<map>) A list of export jobs for the application.
          • ApplicationId — (String) The unique ID of the application associated with the export job.
          • CompletedPieces — (Integer) The number of pieces that have successfully completed as of the time of the request.
          • CompletionDate — (String) The date the job completed in ISO 8601 format.
          • CreationDate — (String) The date the job was created in ISO 8601 format.
          • Definition — (map) The export job settings.
            • RoleArn — (String) The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that endpoints will be exported to.
            • S3UrlPrefix — (String) A URL that points to the location within an Amazon S3 bucket that will receive the export. The location is typically a folder with multiple files. The URL should follow this format: s3://bucket-name/folder-name/ Amazon Pinpoint will export endpoints to this location.
            • SegmentId — (String) The ID of the segment to export endpoints from. If not present, Amazon Pinpoint exports all of the endpoints that belong to the application.
            • SegmentVersion — (Integer) The version of the segment to export if specified.
          • FailedPieces — (Integer) The number of pieces that failed to be processed as of the time of the request.
          • Failures — (Array<String>) Provides up to 100 of the first failed entries for the job, if any exist.
          • Id — (String) The unique ID of the job.
          • JobStatus — (String) The status of the job. Valid values: CREATED, INITIALIZING, PROCESSING, COMPLETING, COMPLETED, FAILING, FAILED The job status is FAILED if one or more pieces failed. Possible values include:
            • "CREATED"
            • "INITIALIZING"
            • "PROCESSING"
            • "COMPLETING"
            • "COMPLETED"
            • "FAILING"
            • "FAILED"
          • TotalFailures — (Integer) The number of endpoints that were not processed; for example, because of syntax errors.
          • TotalPieces — (Integer) The total number of pieces that must be processed to finish the job. Each piece is an approximately equal portion of the endpoints.
          • TotalProcessed — (Integer) The number of endpoints that were processed by the job.
          • Type — (String) The job type. Will be 'EXPORT'.
        • NextToken — (String) The string that you use in a subsequent request to get the next page of results in a paginated response.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getGcmChannel(params = {}, callback) ⇒ AWS.Request

Returns information about the GCM channel for an app.

Service Reference:

Examples:

Calling the getGcmChannel operation

var params = {
  ApplicationId: 'STRING_VALUE' /* required */
};
pinpoint.getGcmChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GCMChannelResponse — (map) Google Cloud Messaging channel definition
        • ApplicationId — (String) The ID of the application to which the channel applies.
        • CreationDate — (String) When was this segment created
        • Credential — (String) The GCM API key from Google.
        • Enabled — (Boolean) If the channel is enabled for sending messages.
        • HasCredential — (Boolean) Not used. Retained for backwards compatibility.
        • Id — (String) Channel ID. Not used. Present only for backwards compatibility.
        • IsArchived — (Boolean) Is this channel archived
        • LastModifiedBy — (String) Who last updated this entry
        • LastModifiedDate — (String) Last date this was updated
        • Platform — (String) The platform type. Will be GCM
        • Version — (Integer) Version of channel

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getImportJob(params = {}, callback) ⇒ AWS.Request

Returns information about an import job.

Service Reference:

Examples:

Calling the getImportJob operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  JobId: 'STRING_VALUE' /* required */
};
pinpoint.getImportJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.
    • JobId — (String) The unique ID of the job.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ImportJobResponse — (map) Import job response.
        • ApplicationId — (String) The unique ID of the application to which the import job applies.
        • CompletedPieces — (Integer) The number of pieces that have successfully imported as of the time of the request.
        • CompletionDate — (String) The date the import job completed in ISO 8601 format.
        • CreationDate — (String) The date the import job was created in ISO 8601 format.
        • Definition — (map) The import job settings.
          • DefineSegment — (Boolean) Sets whether the endpoints create a segment when they are imported.
          • ExternalId — (String) (Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.
          • Format — (String) The format of the files that contain the endpoint definitions. Valid values: CSV, JSON Possible values include:
            • "CSV"
            • "JSON"
          • RegisterEndpoints — (Boolean) Sets whether the endpoints are registered with Amazon Pinpoint when they are imported.
          • RoleArn — (String) The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that contains the endpoints to import.
          • S3Url — (String) The URL of the S3 bucket that contains the segment information to import. The location can be a folder or a single file. The URL should use the following format: s3://bucket-name/folder-name/file-name Amazon Pinpoint imports endpoints from this location and any subfolders it contains.
          • SegmentId — (String) The ID of the segment to update if the import job is meant to update an existing segment.
          • SegmentName — (String) A custom name for the segment created by the import job. Use if DefineSegment is true.
        • FailedPieces — (Integer) The number of pieces that have failed to import as of the time of the request.
        • Failures — (Array<String>) Provides up to 100 of the first failed entries for the job, if any exist.
        • Id — (String) The unique ID of the import job.
        • JobStatus — (String) The status of the import job. Valid values: CREATED, INITIALIZING, PROCESSING, COMPLETING, COMPLETED, FAILING, FAILED The job status is FAILED if one or more pieces failed to import. Possible values include:
          • "CREATED"
          • "INITIALIZING"
          • "PROCESSING"
          • "COMPLETING"
          • "COMPLETED"
          • "FAILING"
          • "FAILED"
        • TotalFailures — (Integer) The number of endpoints that failed to import; for example, because of syntax errors.
        • TotalPieces — (Integer) The total number of pieces that must be imported to finish the job. Each piece is an approximately equal portion of the endpoints to import.
        • TotalProcessed — (Integer) The number of endpoints that were processed by the import job.
        • Type — (String) The job type. Will be Import.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getImportJobs(params = {}, callback) ⇒ AWS.Request

Returns information about your import jobs.

Service Reference:

Examples:

Calling the getImportJobs operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  PageSize: 'STRING_VALUE',
  Token: 'STRING_VALUE'
};
pinpoint.getImportJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.
    • PageSize — (String) The number of entries you want on each page in the response.
    • Token — (String) The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ImportJobsResponse — (map) Import job list.
        • Item — (Array<map>) A list of import jobs for the application.
          • ApplicationId — (String) The unique ID of the application to which the import job applies.
          • CompletedPieces — (Integer) The number of pieces that have successfully imported as of the time of the request.
          • CompletionDate — (String) The date the import job completed in ISO 8601 format.
          • CreationDate — (String) The date the import job was created in ISO 8601 format.
          • Definition — (map) The import job settings.
            • DefineSegment — (Boolean) Sets whether the endpoints create a segment when they are imported.
            • ExternalId — (String) (Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.
            • Format — (String) The format of the files that contain the endpoint definitions. Valid values: CSV, JSON Possible values include:
              • "CSV"
              • "JSON"
            • RegisterEndpoints — (Boolean) Sets whether the endpoints are registered with Amazon Pinpoint when they are imported.
            • RoleArn — (String) The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that contains the endpoints to import.
            • S3Url — (String) The URL of the S3 bucket that contains the segment information to import. The location can be a folder or a single file. The URL should use the following format: s3://bucket-name/folder-name/file-name Amazon Pinpoint imports endpoints from this location and any subfolders it contains.
            • SegmentId — (String) The ID of the segment to update if the import job is meant to update an existing segment.
            • SegmentName — (String) A custom name for the segment created by the import job. Use if DefineSegment is true.
          • FailedPieces — (Integer) The number of pieces that have failed to import as of the time of the request.
          • Failures — (Array<String>) Provides up to 100 of the first failed entries for the job, if any exist.
          • Id — (String) The unique ID of the import job.
          • JobStatus — (String) The status of the import job. Valid values: CREATED, INITIALIZING, PROCESSING, COMPLETING, COMPLETED, FAILING, FAILED The job status is FAILED if one or more pieces failed to import. Possible values include:
            • "CREATED"
            • "INITIALIZING"
            • "PROCESSING"
            • "COMPLETING"
            • "COMPLETED"
            • "FAILING"
            • "FAILED"
          • TotalFailures — (Integer) The number of endpoints that failed to import; for example, because of syntax errors.
          • TotalPieces — (Integer) The total number of pieces that must be imported to finish the job. Each piece is an approximately equal portion of the endpoints to import.
          • TotalProcessed — (Integer) The number of endpoints that were processed by the import job.
          • Type — (String) The job type. Will be Import.
        • NextToken — (String) The string that you use in a subsequent request to get the next page of results in a paginated response.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getSegment(params = {}, callback) ⇒ AWS.Request

Returns information about a segment.

Service Reference:

Examples:

Calling the getSegment operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  SegmentId: 'STRING_VALUE' /* required */
};
pinpoint.getSegment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.
    • SegmentId — (String) The unique ID of the segment.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SegmentResponse — (map) Segment definition.
        • ApplicationId — (String) The ID of the application that the segment applies to.
        • Arn — (String) The arn for the segment.
        • CreationDate — (String) The date and time when the segment was created.
        • Dimensions — (map) The segment dimensions attributes.
          • Attributes — (map<map>) Custom segment attributes.
            • 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. Possible values include:
              • "INCLUSIVE"
              • "EXCLUSIVE"
            • Values — (Array<String>) 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.
          • Behavior — (map) The segment behaviors attributes.
            • Recency — (map) The recency of use.
              • Duration — (String) The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30 Possible values include:
                • "HR_24"
                • "DAY_7"
                • "DAY_14"
                • "DAY_30"
              • RecencyType — (String) The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment. Possible values include:
                • "ACTIVE"
                • "INACTIVE"
          • Demographic — (map) The segment demographics attributes.
            • AppVersion — (map) The app version criteria for the segment.
              • 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. Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Values — (Array<String>) 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.
            • Channel — (map) The channel criteria for the segment.
              • 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. Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Values — (Array<String>) 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.
            • DeviceType — (map) The device type criteria for the segment.
              • 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. Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Values — (Array<String>) 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.
            • Make — (map) The device make criteria for the segment.
              • 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. Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Values — (Array<String>) 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.
            • Model — (map) The device model criteria for the segment.
              • 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. Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Values — (Array<String>) 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.
            • Platform — (map) The device platform criteria for the segment.
              • 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. Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Values — (Array<String>) 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.
          • Location — (map) The segment location attributes.
            • Country — (map) The country or region, in ISO 3166-1 alpha-2 format.
              • 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. Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Values — (Array<String>) 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.
            • GPSPoint — (map) The GPS Point dimension.
              • Coordinates — (map) Coordinate to measure distance from.
                • Latitude — (Float) Latitude
                • Longitude — (Float) Longitude
              • RangeInKilometers — (Float) Range in kilometers from the coordinate.
          • Metrics — (map<map>) Custom segment metrics.
            • 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 — (Float) The value to be compared.
          • UserAttributes — (map<map>) Custom segment user attributes.
            • 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. Possible values include:
              • "INCLUSIVE"
              • "EXCLUSIVE"
            • Values — (Array<String>) 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.
        • Id — (String) The unique segment ID.
        • ImportDefinition — (map) The import job settings.
          • ChannelCounts — (map<Integer>) The number of channel types in the imported segment.
          • ExternalId — (String) (Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.
          • Format — (String) The format of the endpoint files that were imported to create this segment. Valid values: CSV, JSON Possible values include:
            • "CSV"
            • "JSON"
          • RoleArn — (String) The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the endpoints in Amazon S3.
          • S3Url — (String) The URL of the S3 bucket that the segment was imported from.
          • Size — (Integer) The number of endpoints that were successfully imported to create this segment.
        • LastModifiedDate — (String) The date and time when the segment was last modified.
        • Name — (String) The name of the segment.
        • SegmentGroups — (map) A segment group, which consists of zero or more source segments, plus dimensions that are applied to those source segments.
          • Groups — (Array<map>) A set of segment criteria to evaluate.
            • Dimensions — (Array<map>) List of dimensions to include or exclude.
              • Attributes — (map<map>) Custom segment attributes.
                • 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. Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Values — (Array<String>) 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.
              • Behavior — (map) The segment behaviors attributes.
                • Recency — (map) The recency of use.
                  • Duration — (String) The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30 Possible values include:
                    • "HR_24"
                    • "DAY_7"
                    • "DAY_14"
                    • "DAY_30"
                  • RecencyType — (String) The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment. Possible values include:
                    • "ACTIVE"
                    • "INACTIVE"
              • Demographic — (map) The segment demographics attributes.
                • AppVersion — (map) The app version criteria for the segment.
                  • 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
                • Channel — (map) The channel criteria for the segment.
                  • 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
                • DeviceType — (map) The device type criteria for the segment.
                  • 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
                • Make — (map) The device make criteria for the segment.
                  • 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
                • Model — (map) The device model criteria for the segment.
                  • 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
                • Platform — (map) The device platform criteria for the segment.
                  • 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
              • Location — (map) The segment location attributes.
                • Country — (map) The country or region, in ISO 3166-1 alpha-2 format.
                  • 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
                • GPSPoint — (map) The GPS Point dimension.
                  • Coordinates — (map) Coordinate to measure distance from.
                    • Latitude — (Float) Latitude
                    • Longitude — (Float) Longitude
                  • RangeInKilometers — (Float) Range in kilometers from the coordinate.
              • Metrics — (map<map>) Custom segment metrics.
                • 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 — (Float) The value to be compared.
              • UserAttributes — (map<map>) Custom segment user attributes.
                • 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. Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Values — (Array<String>) 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.
            • SourceSegments — (Array<map>) The base segment that you build your segment on. The source segment defines the starting "universe" of endpoints. When you add dimensions to the segment, it filters the source segment based on the dimensions that you specify. You can specify more than one dimensional segment. You can only specify one imported segment. NOTE: If you specify an imported segment for this attribute, the segment size estimate that appears in the Amazon Pinpoint console shows the size of the imported segment, without any filters applied to it.
              • Id — (String) A unique identifier for the segment.
              • Version — (Integer) If specified contains a specific version of the segment included.
            • SourceType — (String) Specify how to handle multiple source segments. For example, if you specify three source segments, should the resulting segment be based on any or all of the segments? Acceptable values: ANY or ALL. Possible values include:
              • "ALL"
              • "ANY"
              • "NONE"
            • Type — (String) Specify how to handle multiple segment dimensions. For example, if you specify three dimensions, should the resulting segment include endpoints that are matched by all, any, or none of the dimensions? Acceptable values: ALL, ANY, or NONE. Possible values include:
              • "ALL"
              • "ANY"
              • "NONE"
          • Include — (String) Specify how to handle multiple segment groups. For example, if the segment includes three segment groups, should the resulting segment include endpoints that are matched by all, any, or none of the segment groups you created. Acceptable values: ALL, ANY, or NONE. Possible values include:
            • "ALL"
            • "ANY"
            • "NONE"
        • SegmentType — (String) The segment type: DIMENSIONAL - A dynamic segment built from selection criteria based on endpoint data reported by your app. You create this type of segment by using the segment builder in the Amazon Pinpoint console or by making a POST request to the segments resource. IMPORT - A static segment built from an imported set of endpoint definitions. You create this type of segment by importing a segment in the Amazon Pinpoint console or by making a POST request to the jobs/import resource. Possible values include:
          • "DIMENSIONAL"
          • "IMPORT"
        • tags — (map<String>) The Tags for the segment.
        • Version — (Integer) The segment version number.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getSegmentExportJobs(params = {}, callback) ⇒ AWS.Request

Returns a list of export jobs for a specific segment.

Service Reference:

Examples:

Calling the getSegmentExportJobs operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  SegmentId: 'STRING_VALUE', /* required */
  PageSize: 'STRING_VALUE',
  Token: 'STRING_VALUE'
};
pinpoint.getSegmentExportJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.
    • PageSize — (String) The number of entries you want on each page in the response.
    • SegmentId — (String) The unique ID of the segment.
    • Token — (String) The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ExportJobsResponse — (map) Export job list.
        • Item — (Array<map>) A list of export jobs for the application.
          • ApplicationId — (String) The unique ID of the application associated with the export job.
          • CompletedPieces — (Integer) The number of pieces that have successfully completed as of the time of the request.
          • CompletionDate — (String) The date the job completed in ISO 8601 format.
          • CreationDate — (String) The date the job was created in ISO 8601 format.
          • Definition — (map) The export job settings.
            • RoleArn — (String) The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that endpoints will be exported to.
            • S3UrlPrefix — (String) A URL that points to the location within an Amazon S3 bucket that will receive the export. The location is typically a folder with multiple files. The URL should follow this format: s3://bucket-name/folder-name/ Amazon Pinpoint will export endpoints to this location.
            • SegmentId — (String) The ID of the segment to export endpoints from. If not present, Amazon Pinpoint exports all of the endpoints that belong to the application.
            • SegmentVersion — (Integer) The version of the segment to export if specified.
          • FailedPieces — (Integer) The number of pieces that failed to be processed as of the time of the request.
          • Failures — (Array<String>) Provides up to 100 of the first failed entries for the job, if any exist.
          • Id — (String) The unique ID of the job.
          • JobStatus — (String) The status of the job. Valid values: CREATED, INITIALIZING, PROCESSING, COMPLETING, COMPLETED, FAILING, FAILED The job status is FAILED if one or more pieces failed. Possible values include:
            • "CREATED"
            • "INITIALIZING"
            • "PROCESSING"
            • "COMPLETING"
            • "COMPLETED"
            • "FAILING"
            • "FAILED"
          • TotalFailures — (Integer) The number of endpoints that were not processed; for example, because of syntax errors.
          • TotalPieces — (Integer) The total number of pieces that must be processed to finish the job. Each piece is an approximately equal portion of the endpoints.
          • TotalProcessed — (Integer) The number of endpoints that were processed by the job.
          • Type — (String) The job type. Will be 'EXPORT'.
        • NextToken — (String) The string that you use in a subsequent request to get the next page of results in a paginated response.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getSegmentImportJobs(params = {}, callback) ⇒ AWS.Request

Returns a list of import jobs for a specific segment.

Service Reference:

Examples:

Calling the getSegmentImportJobs operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  SegmentId: 'STRING_VALUE', /* required */
  PageSize: 'STRING_VALUE',
  Token: 'STRING_VALUE'
};
pinpoint.getSegmentImportJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.
    • PageSize — (String) The number of entries you want on each page in the response.
    • SegmentId — (String) The unique ID of the segment.
    • Token — (String) The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ImportJobsResponse — (map) Import job list.
        • Item — (Array<map>) A list of import jobs for the application.
          • ApplicationId — (String) The unique ID of the application to which the import job applies.
          • CompletedPieces — (Integer) The number of pieces that have successfully imported as of the time of the request.
          • CompletionDate — (String) The date the import job completed in ISO 8601 format.
          • CreationDate — (String) The date the import job was created in ISO 8601 format.
          • Definition — (map) The import job settings.
            • DefineSegment — (Boolean) Sets whether the endpoints create a segment when they are imported.
            • ExternalId — (String) (Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.
            • Format — (String) The format of the files that contain the endpoint definitions. Valid values: CSV, JSON Possible values include:
              • "CSV"
              • "JSON"
            • RegisterEndpoints — (Boolean) Sets whether the endpoints are registered with Amazon Pinpoint when they are imported.
            • RoleArn — (String) The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that contains the endpoints to import.
            • S3Url — (String) The URL of the S3 bucket that contains the segment information to import. The location can be a folder or a single file. The URL should use the following format: s3://bucket-name/folder-name/file-name Amazon Pinpoint imports endpoints from this location and any subfolders it contains.
            • SegmentId — (String) The ID of the segment to update if the import job is meant to update an existing segment.
            • SegmentName — (String) A custom name for the segment created by the import job. Use if DefineSegment is true.
          • FailedPieces — (Integer) The number of pieces that have failed to import as of the time of the request.
          • Failures — (Array<String>) Provides up to 100 of the first failed entries for the job, if any exist.
          • Id — (String) The unique ID of the import job.
          • JobStatus — (String) The status of the import job. Valid values: CREATED, INITIALIZING, PROCESSING, COMPLETING, COMPLETED, FAILING, FAILED The job status is FAILED if one or more pieces failed to import. Possible values include:
            • "CREATED"
            • "INITIALIZING"
            • "PROCESSING"
            • "COMPLETING"
            • "COMPLETED"
            • "FAILING"
            • "FAILED"
          • TotalFailures — (Integer) The number of endpoints that failed to import; for example, because of syntax errors.
          • TotalPieces — (Integer) The total number of pieces that must be imported to finish the job. Each piece is an approximately equal portion of the endpoints to import.
          • TotalProcessed — (Integer) The number of endpoints that were processed by the import job.
          • Type — (String) The job type. Will be Import.
        • NextToken — (String) The string that you use in a subsequent request to get the next page of results in a paginated response.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getSegments(params = {}, callback) ⇒ AWS.Request

Used to get information about your segments.

Service Reference:

Examples:

Calling the getSegments operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  PageSize: 'STRING_VALUE',
  Token: 'STRING_VALUE'
};
pinpoint.getSegments(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.
    • PageSize — (String) The number of entries you want on each page in the response.
    • Token — (String) The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SegmentsResponse — (map) Segments in your account.
        • Item — (Array<map>) The list of segments.
          • ApplicationId — (String) The ID of the application that the segment applies to.
          • Arn — (String) The arn for the segment.
          • CreationDate — (String) The date and time when the segment was created.
          • Dimensions — (map) The segment dimensions attributes.
            • Attributes — (map<map>) Custom segment attributes.
              • 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. Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Values — (Array<String>) 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.
            • Behavior — (map) The segment behaviors attributes.
              • Recency — (map) The recency of use.
                • Duration — (String) The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30 Possible values include:
                  • "HR_24"
                  • "DAY_7"
                  • "DAY_14"
                  • "DAY_30"
                • RecencyType — (String) The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment. Possible values include:
                  • "ACTIVE"
                  • "INACTIVE"
            • Demographic — (map) The segment demographics attributes.
              • AppVersion — (map) The app version criteria for the segment.
                • 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. Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Values — (Array<String>) 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.
              • Channel — (map) The channel criteria for the segment.
                • 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. Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Values — (Array<String>) 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.
              • DeviceType — (map) The device type criteria for the segment.
                • 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. Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Values — (Array<String>) 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.
              • Make — (map) The device make criteria for the segment.
                • 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. Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Values — (Array<String>) 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.
              • Model — (map) The device model criteria for the segment.
                • 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. Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Values — (Array<String>) 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.
              • Platform — (map) The device platform criteria for the segment.
                • 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. Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Values — (Array<String>) 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.
            • Location — (map) The segment location attributes.
              • Country — (map) The country or region, in ISO 3166-1 alpha-2 format.
                • 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. Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Values — (Array<String>) 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.
              • GPSPoint — (map) The GPS Point dimension.
                • Coordinates — (map) Coordinate to measure distance from.
                  • Latitude — (Float) Latitude
                  • Longitude — (Float) Longitude
                • RangeInKilometers — (Float) Range in kilometers from the coordinate.
            • Metrics — (map<map>) Custom segment metrics.
              • 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 — (Float) The value to be compared.
            • UserAttributes — (map<map>) Custom segment user attributes.
              • 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. Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Values — (Array<String>) 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.
          • Id — (String) The unique segment ID.
          • ImportDefinition — (map) The import job settings.
            • ChannelCounts — (map<Integer>) The number of channel types in the imported segment.
            • ExternalId — (String) (Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.
            • Format — (String) The format of the endpoint files that were imported to create this segment. Valid values: CSV, JSON Possible values include:
              • "CSV"
              • "JSON"
            • RoleArn — (String) The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the endpoints in Amazon S3.
            • S3Url — (String) The URL of the S3 bucket that the segment was imported from.
            • Size — (Integer) The number of endpoints that were successfully imported to create this segment.
          • LastModifiedDate — (String) The date and time when the segment was last modified.
          • Name — (String) The name of the segment.
          • SegmentGroups — (map) A segment group, which consists of zero or more source segments, plus dimensions that are applied to those source segments.
            • Groups — (Array<map>) A set of segment criteria to evaluate.
              • Dimensions — (Array<map>) List of dimensions to include or exclude.
                • Attributes — (map<map>) Custom segment attributes.
                  • 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
                • Behavior — (map) The segment behaviors attributes.
                  • Recency — (map) The recency of use.
                    • Duration — (String) The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30 Possible values include:
                      • "HR_24"
                      • "DAY_7"
                      • "DAY_14"
                      • "DAY_30"
                    • RecencyType — (String) The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment. Possible values include:
                      • "ACTIVE"
                      • "INACTIVE"
                • Demographic — (map) The segment demographics attributes.
                  • AppVersion — (map) The app version criteria for the segment.
                    • 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. Possible values include:
                      • "INCLUSIVE"
                      • "EXCLUSIVE"
                    • Values — (Array<String>) 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.
                  • Channel — (map) The channel criteria for the segment.
                    • 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. Possible values include:
                      • "INCLUSIVE"
                      • "EXCLUSIVE"
                    • Values — (Array<String>) 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.
                  • DeviceType — (map) The device type criteria for the segment.
                    • 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. Possible values include:
                      • "INCLUSIVE"
                      • "EXCLUSIVE"
                    • Values — (Array<String>) 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.
                  • Make — (map) The device make criteria for the segment.
                    • 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. Possible values include:
                      • "INCLUSIVE"
                      • "EXCLUSIVE"
                    • Values — (Array<String>) 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.
                  • Model — (map) The device model criteria for the segment.
                    • 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. Possible values include:
                      • "INCLUSIVE"
                      • "EXCLUSIVE"
                    • Values — (Array<String>) 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.
                  • Platform — (map) The device platform criteria for the segment.
                    • 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. Possible values include:
                      • "INCLUSIVE"
                      • "EXCLUSIVE"
                    • Values — (Array<String>) 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.
                • Location — (map) The segment location attributes.
                  • Country — (map) The country or region, in ISO 3166-1 alpha-2 format.
                    • 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. Possible values include:
                      • "INCLUSIVE"
                      • "EXCLUSIVE"
                    • Values — (Array<String>) 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.
                  • GPSPoint — (map) The GPS Point dimension.
                    • Coordinates — (map) Coordinate to measure distance from.
                      • Latitude — (Float) Latitude
                      • Longitude — (Float) Longitude
                    • RangeInKilometers — (Float) Range in kilometers from the coordinate.
                • Metrics — (map<map>) Custom segment metrics.
                  • 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 — (Float) The value to be compared.
                • UserAttributes — (map<map>) Custom segment user attributes.
                  • 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
              • SourceSegments — (Array<map>) The base segment that you build your segment on. The source segment defines the starting "universe" of endpoints. When you add dimensions to the segment, it filters the source segment based on the dimensions that you specify. You can specify more than one dimensional segment. You can only specify one imported segment. NOTE: If you specify an imported segment for this attribute, the segment size estimate that appears in the Amazon Pinpoint console shows the size of the imported segment, without any filters applied to it.
                • Id — (String) A unique identifier for the segment.
                • Version — (Integer) If specified contains a specific version of the segment included.
              • SourceType — (String) Specify how to handle multiple source segments. For example, if you specify three source segments, should the resulting segment be based on any or all of the segments? Acceptable values: ANY or ALL. Possible values include:
                • "ALL"
                • "ANY"
                • "NONE"
              • Type — (String) Specify how to handle multiple segment dimensions. For example, if you specify three dimensions, should the resulting segment include endpoints that are matched by all, any, or none of the dimensions? Acceptable values: ALL, ANY, or NONE. Possible values include:
                • "ALL"
                • "ANY"
                • "NONE"
            • Include — (String) Specify how to handle multiple segment groups. For example, if the segment includes three segment groups, should the resulting segment include endpoints that are matched by all, any, or none of the segment groups you created. Acceptable values: ALL, ANY, or NONE. Possible values include:
              • "ALL"
              • "ANY"
              • "NONE"
          • SegmentType — (String) The segment type: DIMENSIONAL - A dynamic segment built from selection criteria based on endpoint data reported by your app. You create this type of segment by using the segment builder in the Amazon Pinpoint console or by making a POST request to the segments resource. IMPORT - A static segment built from an imported set of endpoint definitions. You create this type of segment by importing a segment in the Amazon Pinpoint console or by making a POST request to the jobs/import resource. Possible values include:
            • "DIMENSIONAL"
            • "IMPORT"
          • tags — (map<String>) The Tags for the segment.
          • Version — (Integer) The segment version number.
        • NextToken — (String) An identifier used to retrieve the next page of results. The token is null if no additional pages exist.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getSegmentVersion(params = {}, callback) ⇒ AWS.Request

Returns information about a segment version.

Service Reference:

Examples:

Calling the getSegmentVersion operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  SegmentId: 'STRING_VALUE', /* required */
  Version: 'STRING_VALUE' /* required */
};
pinpoint.getSegmentVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.
    • SegmentId — (String) The unique ID of the segment.
    • Version — (String) The segment version.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SegmentResponse — (map) Segment definition.
        • ApplicationId — (String) The ID of the application that the segment applies to.
        • Arn — (String) The arn for the segment.
        • CreationDate — (String) The date and time when the segment was created.
        • Dimensions — (map) The segment dimensions attributes.
          • Attributes — (map<map>) Custom segment attributes.
            • 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. Possible values include:
              • "INCLUSIVE"
              • "EXCLUSIVE"
            • Values — (Array<String>) 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.
          • Behavior — (map) The segment behaviors attributes.
            • Recency — (map) The recency of use.
              • Duration — (String) The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30 Possible values include:
                • "HR_24"
                • "DAY_7"
                • "DAY_14"
                • "DAY_30"
              • RecencyType — (String) The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment. Possible values include:
                • "ACTIVE"
                • "INACTIVE"
          • Demographic — (map) The segment demographics attributes.
            • AppVersion — (map) The app version criteria for the segment.
              • 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. Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Values — (Array<String>) 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.
            • Channel — (map) The channel criteria for the segment.
              • 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. Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Values — (Array<String>) 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.
            • DeviceType — (map) The device type criteria for the segment.
              • 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. Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Values — (Array<String>) 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.
            • Make — (map) The device make criteria for the segment.
              • 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. Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Values — (Array<String>) 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.
            • Model — (map) The device model criteria for the segment.
              • 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. Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Values — (Array<String>) 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.
            • Platform — (map) The device platform criteria for the segment.
              • 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. Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Values — (Array<String>) 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.
          • Location — (map) The segment location attributes.
            • Country — (map) The country or region, in ISO 3166-1 alpha-2 format.
              • 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. Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Values — (Array<String>) 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.
            • GPSPoint — (map) The GPS Point dimension.
              • Coordinates — (map) Coordinate to measure distance from.
                • Latitude — (Float) Latitude
                • Longitude — (Float) Longitude
              • RangeInKilometers — (Float) Range in kilometers from the coordinate.
          • Metrics — (map<map>) Custom segment metrics.
            • 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 — (Float) The value to be compared.
          • UserAttributes — (map<map>) Custom segment user attributes.
            • 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. Possible values include:
              • "INCLUSIVE"
              • "EXCLUSIVE"
            • Values — (Array<String>) 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.
        • Id — (String) The unique segment ID.
        • ImportDefinition — (map) The import job settings.
          • ChannelCounts — (map<Integer>) The number of channel types in the imported segment.
          • ExternalId — (String) (Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.
          • Format — (String) The format of the endpoint files that were imported to create this segment. Valid values: CSV, JSON Possible values include:
            • "CSV"
            • "JSON"
          • RoleArn — (String) The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the endpoints in Amazon S3.
          • S3Url — (String) The URL of the S3 bucket that the segment was imported from.
          • Size — (Integer) The number of endpoints that were successfully imported to create this segment.
        • LastModifiedDate — (String) The date and time when the segment was last modified.
        • Name — (String) The name of the segment.
        • SegmentGroups — (map) A segment group, which consists of zero or more source segments, plus dimensions that are applied to those source segments.
          • Groups — (Array<map>) A set of segment criteria to evaluate.
            • Dimensions — (Array<map>) List of dimensions to include or exclude.
              • Attributes — (map<map>) Custom segment attributes.
                • 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. Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Values — (Array<String>) 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.
              • Behavior — (map) The segment behaviors attributes.
                • Recency — (map) The recency of use.
                  • Duration — (String) The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30 Possible values include:
                    • "HR_24"
                    • "DAY_7"
                    • "DAY_14"
                    • "DAY_30"
                  • RecencyType — (String) The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment. Possible values include:
                    • "ACTIVE"
                    • "INACTIVE"
              • Demographic — (map) The segment demographics attributes.
                • AppVersion — (map) The app version criteria for the segment.
                  • 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
                • Channel — (map) The channel criteria for the segment.
                  • 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
                • DeviceType — (map) The device type criteria for the segment.
                  • 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
                • Make — (map) The device make criteria for the segment.
                  • 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
                • Model — (map) The device model criteria for the segment.
                  • 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
                • Platform — (map) The device platform criteria for the segment.
                  • 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
              • Location — (map) The segment location attributes.
                • Country — (map) The country or region, in ISO 3166-1 alpha-2 format.
                  • 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
                • GPSPoint — (map) The GPS Point dimension.
                  • Coordinates — (map) Coordinate to measure distance from.
                    • Latitude — (Float) Latitude
                    • Longitude — (Float) Longitude
                  • RangeInKilometers — (Float) Range in kilometers from the coordinate.
              • Metrics — (map<map>) Custom segment metrics.
                • 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 — (Float) The value to be compared.
              • UserAttributes — (map<map>) Custom segment user attributes.
                • 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. Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Values — (Array<String>) 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.
            • SourceSegments — (Array<map>) The base segment that you build your segment on. The source segment defines the starting "universe" of endpoints. When you add dimensions to the segment, it filters the source segment based on the dimensions that you specify. You can specify more than one dimensional segment. You can only specify one imported segment. NOTE: If you specify an imported segment for this attribute, the segment size estimate that appears in the Amazon Pinpoint console shows the size of the imported segment, without any filters applied to it.
              • Id — (String) A unique identifier for the segment.
              • Version — (Integer) If specified contains a specific version of the segment included.
            • SourceType — (String) Specify how to handle multiple source segments. For example, if you specify three source segments, should the resulting segment be based on any or all of the segments? Acceptable values: ANY or ALL. Possible values include:
              • "ALL"
              • "ANY"
              • "NONE"
            • Type — (String) Specify how to handle multiple segment dimensions. For example, if you specify three dimensions, should the resulting segment include endpoints that are matched by all, any, or none of the dimensions? Acceptable values: ALL, ANY, or NONE. Possible values include:
              • "ALL"
              • "ANY"
              • "NONE"
          • Include — (String) Specify how to handle multiple segment groups. For example, if the segment includes three segment groups, should the resulting segment include endpoints that are matched by all, any, or none of the segment groups you created. Acceptable values: ALL, ANY, or NONE. Possible values include:
            • "ALL"
            • "ANY"
            • "NONE"
        • SegmentType — (String) The segment type: DIMENSIONAL - A dynamic segment built from selection criteria based on endpoint data reported by your app. You create this type of segment by using the segment builder in the Amazon Pinpoint console or by making a POST request to the segments resource. IMPORT - A static segment built from an imported set of endpoint definitions. You create this type of segment by importing a segment in the Amazon Pinpoint console or by making a POST request to the jobs/import resource. Possible values include:
          • "DIMENSIONAL"
          • "IMPORT"
        • tags — (map<String>) The Tags for the segment.
        • Version — (Integer) The segment version number.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getSegmentVersions(params = {}, callback) ⇒ AWS.Request

Returns information about your segment versions.

Service Reference:

Examples:

Calling the getSegmentVersions operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  SegmentId: 'STRING_VALUE', /* required */
  PageSize: 'STRING_VALUE',
  Token: 'STRING_VALUE'
};
pinpoint.getSegmentVersions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.
    • PageSize — (String) The number of entries you want on each page in the response.
    • SegmentId — (String) The unique ID of the segment.
    • Token — (String) The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SegmentsResponse — (map) Segments in your account.
        • Item — (Array<map>) The list of segments.
          • ApplicationId — (String) The ID of the application that the segment applies to.
          • Arn — (String) The arn for the segment.
          • CreationDate — (String) The date and time when the segment was created.
          • Dimensions — (map) The segment dimensions attributes.
            • Attributes — (map<map>) Custom segment attributes.
              • 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. Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Values — (Array<String>) 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.
            • Behavior — (map) The segment behaviors attributes.
              • Recency — (map) The recency of use.
                • Duration — (String) The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30 Possible values include:
                  • "HR_24"
                  • "DAY_7"
                  • "DAY_14"
                  • "DAY_30"
                • RecencyType — (String) The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment. Possible values include:
                  • "ACTIVE"
                  • "INACTIVE"
            • Demographic — (map) The segment demographics attributes.
              • AppVersion — (map) The app version criteria for the segment.
                • 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. Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Values — (Array<String>) 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.
              • Channel — (map) The channel criteria for the segment.
                • 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. Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Values — (Array<String>) 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.
              • DeviceType — (map) The device type criteria for the segment.
                • 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. Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Values — (Array<String>) 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.
              • Make — (map) The device make criteria for the segment.
                • 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. Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Values — (Array<String>) 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.
              • Model — (map) The device model criteria for the segment.
                • 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. Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Values — (Array<String>) 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.
              • Platform — (map) The device platform criteria for the segment.
                • 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. Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Values — (Array<String>) 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.
            • Location — (map) The segment location attributes.
              • Country — (map) The country or region, in ISO 3166-1 alpha-2 format.
                • 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. Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Values — (Array<String>) 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.
              • GPSPoint — (map) The GPS Point dimension.
                • Coordinates — (map) Coordinate to measure distance from.
                  • Latitude — (Float) Latitude
                  • Longitude — (Float) Longitude
                • RangeInKilometers — (Float) Range in kilometers from the coordinate.
            • Metrics — (map<map>) Custom segment metrics.
              • 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 — (Float) The value to be compared.
            • UserAttributes — (map<map>) Custom segment user attributes.
              • 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. Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Values — (Array<String>) 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.
          • Id — (String) The unique segment ID.
          • ImportDefinition — (map) The import job settings.
            • ChannelCounts — (map<Integer>) The number of channel types in the imported segment.
            • ExternalId — (String) (Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.
            • Format — (String) The format of the endpoint files that were imported to create this segment. Valid values: CSV, JSON Possible values include:
              • "CSV"
              • "JSON"
            • RoleArn — (String) The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the endpoints in Amazon S3.
            • S3Url — (String) The URL of the S3 bucket that the segment was imported from.
            • Size — (Integer) The number of endpoints that were successfully imported to create this segment.
          • LastModifiedDate — (String) The date and time when the segment was last modified.
          • Name — (String) The name of the segment.
          • SegmentGroups — (map) A segment group, which consists of zero or more source segments, plus dimensions that are applied to those source segments.
            • Groups — (Array<map>) A set of segment criteria to evaluate.
              • Dimensions — (Array<map>) List of dimensions to include or exclude.
                • Attributes — (map<map>) Custom segment attributes.
                  • 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
                • Behavior — (map) The segment behaviors attributes.
                  • Recency — (map) The recency of use.
                    • Duration — (String) The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30 Possible values include:
                      • "HR_24"
                      • "DAY_7"
                      • "DAY_14"
                      • "DAY_30"
                    • RecencyType — (String) The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment. Possible values include:
                      • "ACTIVE"
                      • "INACTIVE"
                • Demographic — (map) The segment demographics attributes.
                  • AppVersion — (map) The app version criteria for the segment.
                    • 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. Possible values include:
                      • "INCLUSIVE"
                      • "EXCLUSIVE"
                    • Values — (Array<String>) 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.
                  • Channel — (map) The channel criteria for the segment.
                    • 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. Possible values include:
                      • "INCLUSIVE"
                      • "EXCLUSIVE"
                    • Values — (Array<String>) 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.
                  • DeviceType — (map) The device type criteria for the segment.
                    • 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. Possible values include:
                      • "INCLUSIVE"
                      • "EXCLUSIVE"
                    • Values — (Array<String>) 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.
                  • Make — (map) The device make criteria for the segment.
                    • 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. Possible values include:
                      • "INCLUSIVE"
                      • "EXCLUSIVE"
                    • Values — (Array<String>) 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.
                  • Model — (map) The device model criteria for the segment.
                    • 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. Possible values include:
                      • "INCLUSIVE"
                      • "EXCLUSIVE"
                    • Values — (Array<String>) 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.
                  • Platform — (map) The device platform criteria for the segment.
                    • 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. Possible values include:
                      • "INCLUSIVE"
                      • "EXCLUSIVE"
                    • Values — (Array<String>) 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.
                • Location — (map) The segment location attributes.
                  • Country — (map) The country or region, in ISO 3166-1 alpha-2 format.
                    • 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. Possible values include:
                      • "INCLUSIVE"
                      • "EXCLUSIVE"
                    • Values — (Array<String>) 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.
                  • GPSPoint — (map) The GPS Point dimension.
                    • Coordinates — (map) Coordinate to measure distance from.
                      • Latitude — (Float) Latitude
                      • Longitude — (Float) Longitude
                    • RangeInKilometers — (Float) Range in kilometers from the coordinate.
                • Metrics — (map<map>) Custom segment metrics.
                  • 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 — (Float) The value to be compared.
                • UserAttributes — (map<map>) Custom segment user attributes.
                  • 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
              • SourceSegments — (Array<map>) The base segment that you build your segment on. The source segment defines the starting "universe" of endpoints. When you add dimensions to the segment, it filters the source segment based on the dimensions that you specify. You can specify more than one dimensional segment. You can only specify one imported segment. NOTE: If you specify an imported segment for this attribute, the segment size estimate that appears in the Amazon Pinpoint console shows the size of the imported segment, without any filters applied to it.
                • Id — (String) A unique identifier for the segment.
                • Version — (Integer) If specified contains a specific version of the segment included.
              • SourceType — (String) Specify how to handle multiple source segments. For example, if you specify three source segments, should the resulting segment be based on any or all of the segments? Acceptable values: ANY or ALL. Possible values include:
                • "ALL"
                • "ANY"
                • "NONE"
              • Type — (String) Specify how to handle multiple segment dimensions. For example, if you specify three dimensions, should the resulting segment include endpoints that are matched by all, any, or none of the dimensions? Acceptable values: ALL, ANY, or NONE. Possible values include:
                • "ALL"
                • "ANY"
                • "NONE"
            • Include — (String) Specify how to handle multiple segment groups. For example, if the segment includes three segment groups, should the resulting segment include endpoints that are matched by all, any, or none of the segment groups you created. Acceptable values: ALL, ANY, or NONE. Possible values include:
              • "ALL"
              • "ANY"
              • "NONE"
          • SegmentType — (String) The segment type: DIMENSIONAL - A dynamic segment built from selection criteria based on endpoint data reported by your app. You create this type of segment by using the segment builder in the Amazon Pinpoint console or by making a POST request to the segments resource. IMPORT - A static segment built from an imported set of endpoint definitions. You create this type of segment by importing a segment in the Amazon Pinpoint console or by making a POST request to the jobs/import resource. Possible values include:
            • "DIMENSIONAL"
            • "IMPORT"
          • tags — (map<String>) The Tags for the segment.
          • Version — (Integer) The segment version number.
        • NextToken — (String) An identifier used to retrieve the next page of results. The token is null if no additional pages exist.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getSmsChannel(params = {}, callback) ⇒ AWS.Request

Get an SMS channel.

Service Reference:

Examples:

Calling the getSmsChannel operation

var params = {
  ApplicationId: 'STRING_VALUE' /* required */
};
pinpoint.getSmsChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SMSChannelResponse — (map) SMS Channel Response.
        • ApplicationId — (String) The unique ID of the application to which the SMS channel belongs.
        • CreationDate — (String) The date that the settings were last updated in ISO 8601 format.
        • Enabled — (Boolean) If the channel is enabled for sending messages.
        • HasCredential — (Boolean) Not used. Retained for backwards compatibility.
        • Id — (String) Channel ID. Not used, only for backwards compatibility.
        • IsArchived — (Boolean) Is this channel archived
        • LastModifiedBy — (String) Who last updated this entry
        • LastModifiedDate — (String) Last date this was updated
        • Platform — (String) Platform type. Will be "SMS"
        • PromotionalMessagesPerSecond — (Integer) Promotional messages per second that can be sent
        • SenderId — (String) Sender identifier of your messages.
        • ShortCode — (String) The short code registered with the phone provider.
        • TransactionalMessagesPerSecond — (Integer) Transactional messages per second that can be sent
        • Version — (Integer) Version of channel

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getUserEndpoints(params = {}, callback) ⇒ AWS.Request

Returns information about the endpoints that are associated with a User ID.

Service Reference:

Examples:

Calling the getUserEndpoints operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  UserId: 'STRING_VALUE' /* required */
};
pinpoint.getUserEndpoints(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.
    • UserId — (String) The unique ID of the user.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • EndpointsResponse — (map) List of endpoints
        • Item — (Array<map>) The list of endpoints.
          • Address — (String) The address of the endpoint as provided by your push provider. For example, the DeviceToken or RegistrationId.
          • ApplicationId — (String) The ID of the application that is associated with the endpoint.
          • Attributes — (map<Array<String>>) Custom attributes that describe the endpoint by associating a name with an array of values. For example, an attribute named "interests" might have the following values: ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create segments. The Amazon Pinpoint console can't display attribute names that include the following characters: hash/pound sign (#), colon (:), question mark (?), backslash (), and forward slash (/). For this reason, you should avoid using these characters in the names of custom attributes.
          • ChannelType — (String) The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU Possible values include:
            • "GCM"
            • "APNS"
            • "APNS_SANDBOX"
            • "APNS_VOIP"
            • "APNS_VOIP_SANDBOX"
            • "ADM"
            • "SMS"
            • "VOICE"
            • "EMAIL"
            • "BAIDU"
            • "CUSTOM"
          • CohortId — (String) A number from 0-99 that represents the cohort the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an app. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for a campaign.
          • CreationDate — (String) The date and time when the endpoint was created, shown in ISO 8601 format.
          • Demographic — (map) The endpoint demographic attributes.
            • AppVersion — (String) The version of the application associated with the endpoint.
            • Locale — (String) The endpoint locale in the following format: The ISO 639-1 alpha-2 code, followed by an underscore, followed by an ISO 3166-1 alpha-2 value.
            • Make — (String) The manufacturer of the endpoint device, such as Apple or Samsung.
            • Model — (String) The model name or number of the endpoint device, such as iPhone.
            • ModelVersion — (String) The model version of the endpoint device.
            • Platform — (String) The platform of the endpoint device, such as iOS or Android.
            • PlatformVersion — (String) The platform version of the endpoint device.
            • Timezone — (String) The timezone of the endpoint. Specified as a tz database value, such as Americas/Los_Angeles.
          • EffectiveDate — (String) The date and time when the endpoint was last updated, shown in ISO 8601 format.
          • EndpointStatus — (String) Unused.
          • Id — (String) The unique ID that you assigned to the endpoint. The ID should be a globally unique identifier (GUID) to ensure that it doesn't conflict with other endpoint IDs associated with the application.
          • Location — (map) The endpoint location attributes.
            • City — (String) The city where the endpoint is located.
            • Country — (String) The two-letter code for the country or region of the endpoint. Specified as an ISO 3166-1 alpha-2 code, such as "US" for the United States.
            • Latitude — (Float) The latitude of the endpoint location, rounded to one decimal place.
            • Longitude — (Float) The longitude of the endpoint location, rounded to one decimal place.
            • PostalCode — (String) The postal code or zip code of the endpoint.
            • Region — (String) The region of the endpoint location. For example, in the United States, this corresponds to a state.
          • Metrics — (map<Float>) Custom metrics that your app reports to Amazon Pinpoint.
          • OptOut — (String) Indicates whether a user has opted out of receiving messages with one of the following values: ALL - User has opted out of all messages. NONE - Users has not opted out and receives all messages.
          • RequestId — (String) The unique ID for the most recent request to update the endpoint.
          • User — (map) Custom user-specific attributes that your app reports to Amazon Pinpoint.
            • UserAttributes — (map<Array<String>>) Custom attributes that describe the user by associating a name with an array of values. For example, an attribute named "interests" might have the following values: ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create segments. The Amazon Pinpoint console can't display attribute names that include the following characters: hash/pound sign (#), colon (:), question mark (?), backslash (), and forward slash (/). For this reason, you should avoid using these characters in the names of custom attributes.
            • UserId — (String) The unique ID of the user.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getVoiceChannel(params = {}, callback) ⇒ AWS.Request

Get a Voice Channel

Service Reference:

Examples:

Calling the getVoiceChannel operation

var params = {
  ApplicationId: 'STRING_VALUE' /* required */
};
pinpoint.getVoiceChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • VoiceChannelResponse — (map) Voice Channel Response.
        • ApplicationId — (String) Application id
        • CreationDate — (String) The date that the settings were last updated in ISO 8601 format.
        • Enabled — (Boolean) If the channel is enabled for sending messages.
        • HasCredential — (Boolean)
        • Id — (String) Channel ID. Not used, only for backwards compatibility.
        • IsArchived — (Boolean) Is this channel archived
        • LastModifiedBy — (String) Who made the last change
        • LastModifiedDate — (String) Last date this was updated
        • Platform — (String) Platform type. Will be "Voice"
        • Version — (Integer) Version of channel

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Calls the ListTagsForResource API operation.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
pinpoint.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TagsModel — (map)
        • tags — required — (map<String>)

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

phoneNumberValidate(params = {}, callback) ⇒ AWS.Request

Returns information about the specified phone number.

Service Reference:

Examples:

Calling the phoneNumberValidate operation

var params = {
  NumberValidateRequest: { /* required */
    IsoCountryCode: 'STRING_VALUE',
    PhoneNumber: 'STRING_VALUE'
  }
};
pinpoint.phoneNumberValidate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NumberValidateRequest — (map) Phone Number Validate request.
      • IsoCountryCode — (String) (Optional) The two-character ISO country code for the country or region where the phone number was originally registered.
      • PhoneNumber — (String) The phone number to get information about. The phone number that you provide should include a country code. If the number doesn't include a valid country code, the operation might result in an error.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NumberValidateResponse — (map) Phone Number Validate response.
        • Carrier — (String) The carrier or servive provider that the phone number is currently registered with.
        • City — (String) The city where the phone number was originally registered.
        • CleansedPhoneNumberE164 — (String) The cleansed phone number, shown in E.164 format.
        • CleansedPhoneNumberNational — (String) The cleansed phone number, shown in the local phone number format.
        • Country — (String) The country or region where the phone number was originally registered.
        • CountryCodeIso2 — (String) The two-character ISO code for the country or region where the phone number was originally registered.
        • CountryCodeNumeric — (String) The numeric code for the country or region where the phone number was originally registered.
        • County — (String) The county where the phone number was originally registered.
        • OriginalCountryCodeIso2 — (String) The two-character code (in ISO 3166-1 alpha-2 format) for the country or region in the request body.
        • OriginalPhoneNumber — (String) The phone number that you included in the request body.
        • PhoneType — (String) A description of the phone type. Possible values are MOBILE, LANDLINE, VOIP, INVALID, PREPAID, and OTHER.
        • PhoneTypeCode — (Integer) The phone type, represented by an integer. Possible values include 0 (MOBILE), 1 (LANDLINE), 2 (VOIP), 3 (INVALID), 4 (OTHER), and 5 (PREPAID).
        • Timezone — (String) The time zone for the location where the phone number was originally registered.
        • ZipCode — (String) The postal code for the location where the phone number was originally registered.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putEvents(params = {}, callback) ⇒ AWS.Request

Use to record events for endpoints. This method creates events and creates or updates the endpoints that those events are associated with.

Service Reference:

Examples:

Calling the putEvents operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  EventsRequest: { /* required */
    BatchItem: {
      '<__string>': {
        Endpoint: {
          Address: 'STRING_VALUE',
          Attributes: {
            '<__string>': [
              'STRING_VALUE',
              /* more items */
            ],
            /* '<__string>': ... */
          },
          ChannelType: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | VOICE | EMAIL | BAIDU | CUSTOM,
          Demographic: {
            AppVersion: 'STRING_VALUE',
            Locale: 'STRING_VALUE',
            Make: 'STRING_VALUE',
            Model: 'STRING_VALUE',
            ModelVersion: 'STRING_VALUE',
            Platform: 'STRING_VALUE',
            PlatformVersion: 'STRING_VALUE',
            Timezone: 'STRING_VALUE'
          },
          EffectiveDate: 'STRING_VALUE',
          EndpointStatus: 'STRING_VALUE',
          Location: {
            City: 'STRING_VALUE',
            Country: 'STRING_VALUE',
            Latitude: 'NUMBER_VALUE',
            Longitude: 'NUMBER_VALUE',
            PostalCode: 'STRING_VALUE',
            Region: 'STRING_VALUE'
          },
          Metrics: {
            '<__string>': 'NUMBER_VALUE',
            /* '<__string>': ... */
          },
          OptOut: 'STRING_VALUE',
          RequestId: 'STRING_VALUE',
          User: {
            UserAttributes: {
              '<__string>': [
                'STRING_VALUE',
                /* more items */
              ],
              /* '<__string>': ... */
            },
            UserId: 'STRING_VALUE'
          }
        },
        Events: {
          '<__string>': {
            AppPackageName: 'STRING_VALUE',
            AppTitle: 'STRING_VALUE',
            AppVersionCode: 'STRING_VALUE',
            Attributes: {
              '<__string>': 'STRING_VALUE',
              /* '<__string>': ... */
            },
            ClientSdkVersion: 'STRING_VALUE',
            EventType: 'STRING_VALUE',
            Metrics: {
              '<__string>': 'NUMBER_VALUE',
              /* '<__string>': ... */
            },
            SdkName: 'STRING_VALUE',
            Session: {
              Duration: 'NUMBER_VALUE',
              Id: 'STRING_VALUE',
              StartTimestamp: 'STRING_VALUE',
              StopTimestamp: 'STRING_VALUE'
            },
            Timestamp: 'STRING_VALUE'
          },
          /* '<__string>': ... */
        }
      },
      /* '<__string>': ... */
    }
  }
};
pinpoint.putEvents(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.
    • EventsRequest — (map) A set of events to process.
      • BatchItem — (map<map>) A batch of events to process. Each BatchItem consists of an endpoint ID as the key, and an EventsBatch object as the value.
        • Endpoint — (map) The PublicEndpoint attached to the EndpointId from the request.
          • Address — (String) The unique identifier for the recipient. For example, an address could be a device token, email address, or mobile phone number.
          • Attributes — (map<Array<String>>) Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create a segment.
          • ChannelType — (String) The channel type. Valid values: APNS, GCM Possible values include:
            • "GCM"
            • "APNS"
            • "APNS_SANDBOX"
            • "APNS_VOIP"
            • "APNS_VOIP_SANDBOX"
            • "ADM"
            • "SMS"
            • "VOICE"
            • "EMAIL"
            • "BAIDU"
            • "CUSTOM"
          • Demographic — (map) The endpoint demographic attributes.
            • AppVersion — (String) The version of the application associated with the endpoint.
            • Locale — (String) The endpoint locale in the following format: The ISO 639-1 alpha-2 code, followed by an underscore, followed by an ISO 3166-1 alpha-2 value.
            • Make — (String) The manufacturer of the endpoint device, such as Apple or Samsung.
            • Model — (String) The model name or number of the endpoint device, such as iPhone.
            • ModelVersion — (String) The model version of the endpoint device.
            • Platform — (String) The platform of the endpoint device, such as iOS or Android.
            • PlatformVersion — (String) The platform version of the endpoint device.
            • Timezone — (String) The timezone of the endpoint. Specified as a tz database value, such as Americas/Los_Angeles.
          • EffectiveDate — (String) The date and time when the endpoint was last updated, in ISO 8601 format.
          • EndpointStatus — (String) The status of the endpoint. If the update fails, the value is INACTIVE. If the endpoint is updated successfully, the value is ACTIVE.
          • Location — (map) The endpoint location attributes.
            • City — (String) The city where the endpoint is located.
            • Country — (String) The two-letter code for the country or region of the endpoint. Specified as an ISO 3166-1 alpha-2 code, such as "US" for the United States.
            • Latitude — (Float) The latitude of the endpoint location, rounded to one decimal place.
            • Longitude — (Float) The longitude of the endpoint location, rounded to one decimal place.
            • PostalCode — (String) The postal code or zip code of the endpoint.
            • Region — (String) The region of the endpoint location. For example, in the United States, this corresponds to a state.
          • Metrics — (map<Float>) Custom metrics that your app reports to Amazon Pinpoint.
          • OptOut — (String) Indicates whether a user has opted out of receiving messages with one of the following values: ALL - User has opted out of all messages. NONE - Users has not opted out and receives all messages.
          • RequestId — (String) A unique identifier that is generated each time the endpoint is updated.
          • User — (map) Custom user-specific attributes that your app reports to Amazon Pinpoint.
            • UserAttributes — (map<Array<String>>) Custom attributes that describe the user by associating a name with an array of values. For example, an attribute named "interests" might have the following values: ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create segments. The Amazon Pinpoint console can't display attribute names that include the following characters: hash/pound sign (#), colon (:), question mark (?), backslash (), and forward slash (/). For this reason, you should avoid using these characters in the names of custom attributes.
            • UserId — (String) The unique ID of the user.
        • Events — (map<map>) An object that contains a set of events associated with the endpoint.
          • AppPackageName — (String) The package name associated with the app that's recording the event.
          • AppTitle — (String) The title of the app that's recording the event.
          • AppVersionCode — (String) The version number of the app that's recording the event.
          • Attributes — (map<String>) Custom attributes that are associated with the event you're adding or updating.
          • ClientSdkVersion — (String) The version of the SDK that's running on the client device.
          • EventType — (String) The name of the custom event that you're recording.
          • Metrics — (map<Float>) Custom metrics related to the event.
          • SdkName — (String) The name of the SDK that's being used to record the event.
          • Session — (map) Information about the session in which the event occurred.
            • Duration — (Integer) The duration of the session, in milliseconds.
            • Id — (String) A unique identifier for the session.
            • StartTimestamp — (String) The date and time when the session began.
            • StopTimestamp — (String) The date and time when the session ended.
          • Timestamp — (String) The date and time when the event occurred, in ISO 8601 format.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • EventsResponse — (map) Custom messages associated with events.
        • Results — (map<map>) A map that contains a multipart response for each endpoint. Each item in this object uses the endpoint ID as the key, and the item response as the value. If no item response exists, the value can also be one of the following: 202 (if the request was processed successfully) or 400 (if the payload was invalid, or required fields were missing).
          • EndpointItemResponse — (map) The response received after the endpoint was accepted.
            • Message — (String) A custom message associated with the registration of an endpoint when issuing a response.
            • StatusCode — (Integer) The status code associated with the merging of an endpoint when issuing a response.
          • EventsItemResponse — (map<map>) A multipart response object that contains a key and value for each event ID in the request. In each object, the event ID is the key, and an EventItemResponse object is the value.
            • Message — (String) A custom message that is associated with the processing of an event.
            • StatusCode — (Integer) The status returned in the response as a result of processing the event. Possible values: 400 (for invalid events) and 202 (for events that were accepted).

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putEventStream(params = {}, callback) ⇒ AWS.Request

Use to create or update the event stream for an app.

Service Reference:

Examples:

Calling the putEventStream operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  WriteEventStream: { /* required */
    DestinationStreamArn: 'STRING_VALUE',
    RoleArn: 'STRING_VALUE'
  }
};
pinpoint.putEventStream(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.
    • WriteEventStream — (map) Request to save an EventStream.
      • DestinationStreamArn — (String) The Amazon Resource Name (ARN) of the Amazon Kinesis stream or Firehose delivery stream to which you want to publish events. Firehose ARN: arn:aws:firehose:REGION:ACCOUNT_ID:deliverystream/STREAM_NAME Kinesis ARN: arn:aws:kinesis:REGION:ACCOUNT_ID:stream/STREAM_NAME
      • RoleArn — (String) The IAM role that authorizes Amazon Pinpoint to publish events to the stream in your account.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • EventStream — (map) Model for an event publishing subscription export.
        • ApplicationId — (String) The ID of the application from which events should be published.
        • DestinationStreamArn — (String) The Amazon Resource Name (ARN) of the Amazon Kinesis stream or Firehose delivery stream to which you want to publish events. Firehose ARN: arn:aws:firehose:REGION:ACCOUNT_ID:deliverystream/STREAM_NAME Kinesis ARN: arn:aws:kinesis:REGION:ACCOUNT_ID:stream/STREAM_NAME
        • ExternalId — (String) (Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.
        • LastModifiedDate — (String) The date the event stream was last updated in ISO 8601 format.
        • LastUpdatedBy — (String) The IAM user who last modified the event stream.
        • RoleArn — (String) The IAM role that authorizes Amazon Pinpoint to publish events to the stream in your account.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

removeAttributes(params = {}, callback) ⇒ AWS.Request

Used to remove the attributes for an app

Service Reference:

Examples:

Calling the removeAttributes operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  AttributeType: 'STRING_VALUE', /* required */
  UpdateAttributesRequest: { /* required */
    Blacklist: [
      'STRING_VALUE',
      /* more items */
    ]
  }
};
pinpoint.removeAttributes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.
    • AttributeType — (String) Type of attribute. Can be endpoint-custom-attributes, endpoint-custom-metrics, endpoint-user-attributes.
    • UpdateAttributesRequest — (map) Update attributes request
      • Blacklist — (Array<String>) The GLOB wildcard for removing the attributes in the application

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AttributesResource — (map) Attributes.
        • ApplicationId — (String) The unique ID for the application.
        • AttributeType — (String) The attribute type for the application.
        • Attributes — (Array<String>) The attributes for the application.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

sendMessages(params = {}, callback) ⇒ AWS.Request

Used to send a direct message.

Service Reference:

Examples:

Calling the sendMessages operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  MessageRequest: { /* required */
    Addresses: {
      '<__string>': {
        BodyOverride: 'STRING_VALUE',
        ChannelType: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | VOICE | EMAIL | BAIDU | CUSTOM,
        Context: {
          '<__string>': 'STRING_VALUE',
          /* '<__string>': ... */
        },
        RawContent: 'STRING_VALUE',
        Substitutions: {
          '<__string>': [
            'STRING_VALUE',
            /* more items */
          ],
          /* '<__string>': ... */
        },
        TitleOverride: 'STRING_VALUE'
      },
      /* '<__string>': ... */
    },
    Context: {
      '<__string>': 'STRING_VALUE',
      /* '<__string>': ... */
    },
    Endpoints: {
      '<__string>': {
        BodyOverride: 'STRING_VALUE',
        Context: {
          '<__string>': 'STRING_VALUE',
          /* '<__string>': ... */
        },
        RawContent: 'STRING_VALUE',
        Substitutions: {
          '<__string>': [
            'STRING_VALUE',
            /* more items */
          ],
          /* '<__string>': ... */
        },
        TitleOverride: 'STRING_VALUE'
      },
      /* '<__string>': ... */
    },
    MessageConfiguration: {
      ADMMessage: {
        Action: OPEN_APP | DEEP_LINK | URL,
        Body: 'STRING_VALUE',
        ConsolidationKey: 'STRING_VALUE',
        Data: {
          '<__string>': 'STRING_VALUE',
          /* '<__string>': ... */
        },
        ExpiresAfter: 'STRING_VALUE',
        IconReference: 'STRING_VALUE',
        ImageIconUrl: 'STRING_VALUE',
        ImageUrl: 'STRING_VALUE',
        MD5: 'STRING_VALUE',
        RawContent: 'STRING_VALUE',
        SilentPush: true || false,
        SmallImageIconUrl: 'STRING_VALUE',
        Sound: 'STRING_VALUE',
        Substitutions: {
          '<__string>': [
            'STRING_VALUE',
            /* more items */
          ],
          /* '<__string>': ... */
        },
        Title: 'STRING_VALUE',
        Url: 'STRING_VALUE'
      },
      APNSMessage: {
        Action: OPEN_APP | DEEP_LINK | URL,
        Badge: 'NUMBER_VALUE',
        Body: 'STRING_VALUE',
        Category: 'STRING_VALUE',
        CollapseId: 'STRING_VALUE',
        Data: {
          '<__string>': 'STRING_VALUE',
          /* '<__string>': ... */
        },
        MediaUrl: 'STRING_VALUE',
        PreferredAuthenticationMethod: 'STRING_VALUE',
        Priority: 'STRING_VALUE',
        RawContent: 'STRING_VALUE',
        SilentPush: true || false,
        Sound: 'STRING_VALUE',
        Substitutions: {
          '<__string>': [
            'STRING_VALUE',
            /* more items */
          ],
          /* '<__string>': ... */
        },
        ThreadId: 'STRING_VALUE',
        TimeToLive: 'NUMBER_VALUE',
        Title: 'STRING_VALUE',
        Url: 'STRING_VALUE'
      },
      BaiduMessage: {
        Action: OPEN_APP | DEEP_LINK | URL,
        Body: 'STRING_VALUE',
        Data: {
          '<__string>': 'STRING_VALUE',
          /* '<__string>': ... */
        },
        IconReference: 'STRING_VALUE',
        ImageIconUrl: 'STRING_VALUE',
        ImageUrl: 'STRING_VALUE',
        RawContent: 'STRING_VALUE',
        SilentPush: true || false,
        SmallImageIconUrl: 'STRING_VALUE',
        Sound: 'STRING_VALUE',
        Substitutions: {
          '<__string>': [
            'STRING_VALUE',
            /* more items */
          ],
          /* '<__string>': ... */
        },
        TimeToLive: 'NUMBER_VALUE',
        Title: 'STRING_VALUE',
        Url: 'STRING_VALUE'
      },
      DefaultMessage: {
        Body: 'STRING_VALUE',
        Substitutions: {
          '<__string>': [
            'STRING_VALUE',
            /* more items */
          ],
          /* '<__string>': ... */
        }
      },
      DefaultPushNotificationMessage: {
        Action: OPEN_APP | DEEP_LINK | URL,
        Body: 'STRING_VALUE',
        Data: {
          '<__string>': 'STRING_VALUE',
          /* '<__string>': ... */
        },
        SilentPush: true || false,
        Substitutions: {
          '<__string>': [
            'STRING_VALUE',
            /* more items */
          ],
          /* '<__string>': ... */
        },
        Title: 'STRING_VALUE',
        Url: 'STRING_VALUE'
      },
      EmailMessage: {
        Body: 'STRING_VALUE',
        FeedbackForwardingAddress: 'STRING_VALUE',
        FromAddress: 'STRING_VALUE',
        RawEmail: {
          Data: new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */
        },
        ReplyToAddresses: [
          'STRING_VALUE',
          /* more items */
        ],
        SimpleEmail: {
          HtmlPart: {
            Charset: 'STRING_VALUE',
            Data: 'STRING_VALUE'
          },
          Subject: {
            Charset: 'STRING_VALUE',
            Data: 'STRING_VALUE'
          },
          TextPart: {
            Charset: 'STRING_VALUE',
            Data: 'STRING_VALUE'
          }
        },
        Substitutions: {
          '<__string>': [
            'STRING_VALUE',
            /* more items */
          ],
          /* '<__string>': ... */
        }
      },
      GCMMessage: {
        Action: OPEN_APP | DEEP_LINK | URL,
        Body: 'STRING_VALUE',
        CollapseKey: 'STRING_VALUE',
        Data: {
          '<__string>': 'STRING_VALUE',
          /* '<__string>': ... */
        },
        IconReference: 'STRING_VALUE',
        ImageIconUrl: 'STRING_VALUE',
        ImageUrl: 'STRING_VALUE',
        Priority: 'STRING_VALUE',
        RawContent: 'STRING_VALUE',
        RestrictedPackageName: 'STRING_VALUE',
        SilentPush: true || false,
        SmallImageIconUrl: 'STRING_VALUE',
        Sound: 'STRING_VALUE',
        Substitutions: {
          '<__string>': [
            'STRING_VALUE',
            /* more items */
          ],
          /* '<__string>': ... */
        },
        TimeToLive: 'NUMBER_VALUE',
        Title: 'STRING_VALUE',
        Url: 'STRING_VALUE'
      },
      SMSMessage: {
        Body: 'STRING_VALUE',
        Keyword: 'STRING_VALUE',
        MessageType: TRANSACTIONAL | PROMOTIONAL,
        OriginationNumber: 'STRING_VALUE',
        SenderId: 'STRING_VALUE',
        Substitutions: {
          '<__string>': [
            'STRING_VALUE',
            /* more items */
          ],
          /* '<__string>': ... */
        }
      },
      VoiceMessage: {
        Body: 'STRING_VALUE',
        LanguageCode: 'STRING_VALUE',
        OriginationNumber: 'STRING_VALUE',
        Substitutions: {
          '<__string>': [
            'STRING_VALUE',
            /* more items */
          ],
          /* '<__string>': ... */
        },
        VoiceId: 'STRING_VALUE'
      }
    },
    TraceId: 'STRING_VALUE'
  }
};
pinpoint.sendMessages(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.
    • MessageRequest — (map) Send message request.
      • Addresses — (map<map>) A map of key-value pairs, where each key is an address and each value is an AddressConfiguration object. An address can be a push notification token, a phone number, or an email address.
        • BodyOverride — (String) Body override. If specified will override default body.
        • ChannelType — (String) The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU Possible values include:
          • "GCM"
          • "APNS"
          • "APNS_SANDBOX"
          • "APNS_VOIP"
          • "APNS_VOIP_SANDBOX"
          • "ADM"
          • "SMS"
          • "VOICE"
          • "EMAIL"
          • "BAIDU"
          • "CUSTOM"
        • Context — (map<String>) A map of custom attributes to attributes to be attached to the message for this address. This payload is added to the push notification's 'data.pinpoint' object or added to the email/sms delivery receipt event attributes.
        • RawContent — (String) The Raw JSON formatted string to be used as the payload. This value overrides the message.
        • Substitutions — (map<Array<String>>) A map of substitution values for the message to be merged with the DefaultMessage's substitutions. Substitutions on this map take precedence over the all other substitutions.
        • TitleOverride — (String) Title override. If specified will override default title if applicable.
      • Context — (map<String>) A map of custom attributes to attributes to be attached to the message. This payload is added to the push notification's 'data.pinpoint' object or added to the email/sms delivery receipt event attributes.
      • Endpoints — (map<map>) A map of key-value pairs, where each key is an endpoint ID and each value is an EndpointSendConfiguration object. Within an EndpointSendConfiguration object, you can tailor the message for an endpoint by specifying message overrides or substitutions.
        • BodyOverride — (String) Body override. If specified will override default body.
        • Context — (map<String>) A map of custom attributes to attributes to be attached to the message for this address. This payload is added to the push notification's 'data.pinpoint' object or added to the email/sms delivery receipt event attributes.
        • RawContent — (String) The Raw JSON formatted string to be used as the payload. This value overrides the message.
        • Substitutions — (map<Array<String>>) A map of substitution values for the message to be merged with the DefaultMessage's substitutions. Substitutions on this map take precedence over the all other substitutions.
        • TitleOverride — (String) Title override. If specified will override default title if applicable.
      • MessageConfiguration — (map) Message configuration.
        • ADMMessage — (map) The message to ADM channels. Overrides the default push notification 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. Possible values include: OPEN_APP | DEEP_LINK | URL Possible values include:
            • "OPEN_APP"
            • "DEEP_LINK"
            • "URL"
          • Body — (String) The message body of the notification.
          • ConsolidationKey — (String) Optional. Arbitrary string used to indicate multiple messages are logically the same and that ADM is allowed to drop previously enqueued messages in favor of this one.
          • Data — (map<String>) The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
          • ExpiresAfter — (String) Optional. Number of seconds ADM should retain the message if the device is offline
          • IconReference — (String) The icon image name of the asset saved in your application.
          • ImageIconUrl — (String) The URL that points to an image used as the large icon to the notification content view.
          • ImageUrl — (String) The URL that points to an image used in the push notification.
          • MD5 — (String) Optional. Base-64-encoded MD5 checksum of the data parameter. Used to verify data integrity
          • 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.
          • SmallImageIconUrl — (String) The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view
          • Sound — (String) Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/
          • Substitutions — (map<Array<String>>) Default message substitutions. Can be overridden by individual address substitutions.
          • 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 — (map) The message to APNS channels. Overrides the default push notification 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. Possible values include: OPEN_APP | DEEP_LINK | URL Possible values include:
            • "OPEN_APP"
            • "DEEP_LINK"
            • "URL"
          • Badge — (Integer) Include this key when you want the system to modify the badge of your app icon. If this key is not included in the dictionary, the badge is not changed. To remove the badge, set the value of this key to 0.
          • Body — (String) The message body of the notification.
          • Category — (String) Provide this key with a string value that represents the notification's type. This value corresponds to the value in the identifier property of one of your app's registered categories.
          • CollapseId — (String) An ID that, if assigned to multiple messages, causes APNs to coalesce the messages into a single push notification instead of delivering each message individually. The value must not exceed 64 bytes. Amazon Pinpoint uses this value to set the apns-collapse-id request header when it sends the message to APNs.
          • Data — (map<String>) The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
          • MediaUrl — (String) A URL that refers to the location of an image or video that you want to display in the push notification.
          • PreferredAuthenticationMethod — (String) The preferred authentication method, either "CERTIFICATE" or "TOKEN"
          • Priority — (String) The message priority. Amazon Pinpoint uses this value to set the apns-priority request header when it sends the message to APNs. Accepts the following values: "5" - Low priority. Messages might be delayed, delivered in groups, and throttled. "10" - High priority. Messages are sent immediately. High priority messages must cause an alert, sound, or badge on the receiving device. The default value is "10". The equivalent values for FCM or GCM messages are "normal" and "high". Amazon Pinpoint accepts these values for APNs messages and converts them. For more information about the apns-priority parameter, see Communicating with APNs in the APNs Local and Remote Notification Programming Guide.
          • 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.
          • Sound — (String) Include this key when you want the system to play a sound. The value of this key is the name of a sound file in your app's main bundle or in the Library/Sounds folder of your app's data container. If the sound file cannot be found, or if you specify defaultfor the value, the system plays the default alert sound.
          • Substitutions — (map<Array<String>>) Default message substitutions. Can be overridden by individual address substitutions.
          • ThreadId — (String) Provide this key with a string value that represents the app-specific identifier for grouping notifications. If you provide a Notification Content app extension, you can use this value to group your notifications together.
          • TimeToLive — (Integer) The length of time (in seconds) that APNs stores and attempts to deliver the message. If the value is 0, APNs does not store the message or attempt to deliver it more than once. Amazon Pinpoint uses this value to set the apns-expiration request header when it sends the message to APNs.
          • 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 — (map) The message to Baidu GCM channels. Overrides the default push notification 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. Possible values include: OPEN_APP | DEEP_LINK | URL Possible values include:
            • "OPEN_APP"
            • "DEEP_LINK"
            • "URL"
          • Body — (String) The message body of the notification.
          • Data — (map<String>) The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
          • IconReference — (String) The icon image name of the asset saved in your application.
          • ImageIconUrl — (String) The URL that points to an image used as the large icon to the notification content view.
          • ImageUrl — (String) The URL that points to an image used 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.
          • SmallImageIconUrl — (String) The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view
          • Sound — (String) Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/
          • Substitutions — (map<Array<String>>) Default message substitutions. Can be overridden by individual address substitutions.
          • TimeToLive — (Integer) This parameter specifies how long (in seconds) the message should be kept in Baidu storage if the device is offline. The and the default value and the maximum time to live supported is 7 days (604800 seconds)
          • 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 — (map) The default message for all channels.
          • Body — (String) The message body of the notification, the email body or the text message.
          • Substitutions — (map<Array<String>>) Default message substitutions. Can be overridden by individual address substitutions.
        • DefaultPushNotificationMessage — (map) The default push notification message for all push 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. Possible values include: OPEN_APP | DEEP_LINK | URL Possible values include:
            • "OPEN_APP"
            • "DEEP_LINK"
            • "URL"
          • Body — (String) The message body of the notification.
          • Data — (map<String>) The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
          • SilentPush — (Boolean) Indicates if the message should display on the recipient's device. You can use silent pushes for remote configuration or to deliver messages to in-app notification centers.
          • Substitutions — (map<Array<String>>) Default message substitutions. Can be overridden by individual address substitutions.
          • 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 — (map) The message to Email channels. Overrides the default message.
          • Body — (String) The body of the email message.
          • FeedbackForwardingAddress — (String) The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled.
          • FromAddress — (String) The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.
          • RawEmail — (map) An email represented as a raw MIME message.
            • Data — (Buffer, Typed Array, Blob, String) The raw email message itself. Then entire message must be base64-encoded.
          • ReplyToAddresses — (Array<String>) The reply-to email address(es) for the email. If the recipient replies to the email, each reply-to address will receive the reply.
          • SimpleEmail — (map) An email composed of a subject, a text part and a html part.
            • HtmlPart — (map) The content of the message, in HTML format. Use this for email clients that can process HTML. You can include clickable links, formatted text, and much more in an HTML message.
              • Charset — (String) The character set of the content.
              • Data — (String) The textual data of the content.
            • Subject — (map) The subject of the message: A short summary of the content, which will appear in the recipient's inbox.
              • Charset — (String) The character set of the content.
              • Data — (String) The textual data of the content.
            • TextPart — (map) The content of the message, in text format. Use this for text-based email clients, or clients on high-latency networks (such as mobile devices).
              • Charset — (String) The character set of the content.
              • Data — (String) The textual data of the content.
          • Substitutions — (map<Array<String>>) Default message substitutions. Can be overridden by individual address substitutions.
        • GCMMessage — (map) The message to GCM channels. Overrides the default push notification 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. Possible values include: OPEN_APP | DEEP_LINK | URL Possible values include:
            • "OPEN_APP"
            • "DEEP_LINK"
            • "URL"
          • Body — (String) The message body of the notification.
          • CollapseKey — (String) This parameter identifies a group of messages (e.g., with collapse_key: "Updates Available") that can be collapsed, so that only the last message gets sent when delivery can be resumed. This is intended to avoid sending too many of the same messages when the device comes back online or becomes active.
          • Data — (map<String>) The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
          • IconReference — (String) The icon image name of the asset saved in your application.
          • ImageIconUrl — (String) The URL that points to an image used as the large icon to the notification content view.
          • ImageUrl — (String) The URL that points to an image used in the push notification.
          • Priority — (String) The message priority. Amazon Pinpoint uses this value to set the FCM or GCM priority parameter when it sends the message. Accepts the following values: "Normal" - Messages might be delayed. Delivery is optimized for battery usage on the receiving device. Use normal priority unless immediate delivery is required. "High" - Messages are sent immediately and might wake a sleeping device. The equivalent values for APNs messages are "5" and "10". Amazon Pinpoint accepts these values here and converts them. For more information, see About FCM Messages in the Firebase documentation.
          • RawContent — (String) The Raw JSON formatted string to be used as the payload. This value overrides the message.
          • RestrictedPackageName — (String) This parameter specifies the package name of the application where the registration tokens must match in order to receive 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.
          • SmallImageIconUrl — (String) The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view
          • Sound — (String) Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/
          • Substitutions — (map<Array<String>>) Default message substitutions. Can be overridden by individual address substitutions.
          • TimeToLive — (Integer) The length of time (in seconds) that FCM or GCM stores and attempts to deliver the message. If unspecified, the value defaults to the maximum, which is 2,419,200 seconds (28 days). Amazon Pinpoint uses this value to set the FCM or GCM time_to_live parameter.
          • 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 — (map) The message to SMS channels. Overrides the default message.
          • Body — (String) The body of the SMS message.
          • Keyword — (String) The SMS program name that you provided to AWS Support when you requested your dedicated number.
          • MessageType — (String) Is this a transaction priority message or lower priority. Possible values include:
            • "TRANSACTIONAL"
            • "PROMOTIONAL"
          • OriginationNumber — (String) The phone number that the SMS message originates from. Specify one of the dedicated long codes or short codes that you requested from AWS Support and that is assigned to your account. If this attribute is not specified, Amazon Pinpoint randomly assigns a long code.
          • SenderId — (String) The sender ID that is shown as the message sender on the recipient's device. Support for sender IDs varies by country or region.
          • Substitutions — (map<Array<String>>) Default message substitutions. Can be overridden by individual address substitutions.
        • VoiceMessage — (map) The message to Voice channels. Overrides the default message.
          • Body — (String) The message body of the notification, the email body or the text message.
          • LanguageCode — (String) Language of sent message
          • OriginationNumber — (String) Is the number from the pool or messaging service to send from.
          • Substitutions — (map<Array<String>>) Default message substitutions. Can be overridden by individual address substitutions.
          • VoiceId — (String) Voice ID of sent message.
      • TraceId — (String) A unique ID that you can use to trace a message. This ID is visible to recipients.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • MessageResponse — (map) Send message response.
        • ApplicationId — (String) Application id of the message.
        • EndpointResult — (map<map>) A map containing a multi part response for each address, with the endpointId as the key and the result as the value.
          • Address — (String) Address that endpoint message was delivered to.
          • DeliveryStatus — (String) The delivery status of the message. Possible values: SUCCESS - The message was successfully delivered to the endpoint. TRANSIENT_FAILURE - A temporary error occurred. Amazon Pinpoint will attempt to deliver the message again later. FAILURE_PERMANENT - An error occurred when delivering the message to the endpoint. Amazon Pinpoint won't attempt to send the message again. TIMEOUT - The message couldn't be sent within the timeout period. QUIET_TIME - The local time for the endpoint was within the QuietTime for the campaign or app. DAILY_CAP - The endpoint has received the maximum number of messages it can receive within a 24-hour period. HOLDOUT - The endpoint was in a hold out treatment for the campaign. THROTTLED - Amazon Pinpoint throttled sending to this endpoint. EXPIRED - The endpoint address is expired. CAMPAIGN_CAP - The endpoint received the maximum number of messages allowed by the campaign. SERVICE_FAILURE - A service-level failure prevented Amazon Pinpoint from delivering the message. UNKNOWN - An unknown error occurred. Possible values include:
            • "SUCCESSFUL"
            • "THROTTLED"
            • "TEMPORARY_FAILURE"
            • "PERMANENT_FAILURE"
            • "UNKNOWN_FAILURE"
            • "OPT_OUT"
            • "DUPLICATE"
          • MessageId — (String) Unique message identifier associated with the message that was sent.
          • StatusCode — (Integer) Downstream service status code.
          • StatusMessage — (String) Status message for message delivery.
          • UpdatedToken — (String) If token was updated as part of delivery. (This is GCM Specific)
        • RequestId — (String) Original request Id for which this message was delivered.
        • Result — (map<map>) A map containing a multi part response for each address, with the address as the key(Email address, phone number or push token) and the result as the value.
          • DeliveryStatus — (String) The delivery status of the message. Possible values: SUCCESS - The message was successfully delivered to the endpoint. TRANSIENT_FAILURE - A temporary error occurred. Amazon Pinpoint will attempt to deliver the message again later. FAILURE_PERMANENT - An error occurred when delivering the message to the endpoint. Amazon Pinpoint won't attempt to send the message again. TIMEOUT - The message couldn't be sent within the timeout period. QUIET_TIME - The local time for the endpoint was within the QuietTime for the campaign or app. DAILY_CAP - The endpoint has received the maximum number of messages it can receive within a 24-hour period. HOLDOUT - The endpoint was in a hold out treatment for the campaign. THROTTLED - Amazon Pinpoint throttled sending to this endpoint. EXPIRED - The endpoint address is expired. CAMPAIGN_CAP - The endpoint received the maximum number of messages allowed by the campaign. SERVICE_FAILURE - A service-level failure prevented Amazon Pinpoint from delivering the message. UNKNOWN - An unknown error occurred. Possible values include:
            • "SUCCESSFUL"
            • "THROTTLED"
            • "TEMPORARY_FAILURE"
            • "PERMANENT_FAILURE"
            • "UNKNOWN_FAILURE"
            • "OPT_OUT"
            • "DUPLICATE"
          • MessageId — (String) Unique message identifier associated with the message that was sent.
          • StatusCode — (Integer) Downstream service status code.
          • StatusMessage — (String) Status message for message delivery.
          • UpdatedToken — (String) If token was updated as part of delivery. (This is GCM Specific)

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

sendUsersMessages(params = {}, callback) ⇒ AWS.Request

Used to send a message to a list of users.

Service Reference:

Examples:

Calling the sendUsersMessages operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  SendUsersMessageRequest: { /* required */
    Context: {
      '<__string>': 'STRING_VALUE',
      /* '<__string>': ... */
    },
    MessageConfiguration: {
      ADMMessage: {
        Action: OPEN_APP | DEEP_LINK | URL,
        Body: 'STRING_VALUE',
        ConsolidationKey: 'STRING_VALUE',
        Data: {
          '<__string>': 'STRING_VALUE',
          /* '<__string>': ... */
        },
        ExpiresAfter: 'STRING_VALUE',
        IconReference: 'STRING_VALUE',
        ImageIconUrl: 'STRING_VALUE',
        ImageUrl: 'STRING_VALUE',
        MD5: 'STRING_VALUE',
        RawContent: 'STRING_VALUE',
        SilentPush: true || false,
        SmallImageIconUrl: 'STRING_VALUE',
        Sound: 'STRING_VALUE',
        Substitutions: {
          '<__string>': [
            'STRING_VALUE',
            /* more items */
          ],
          /* '<__string>': ... */
        },
        Title: 'STRING_VALUE',
        Url: 'STRING_VALUE'
      },
      APNSMessage: {
        Action: OPEN_APP | DEEP_LINK | URL,
        Badge: 'NUMBER_VALUE',
        Body: 'STRING_VALUE',
        Category: 'STRING_VALUE',
        CollapseId: 'STRING_VALUE',
        Data: {
          '<__string>': 'STRING_VALUE',
          /* '<__string>': ... */
        },
        MediaUrl: 'STRING_VALUE',
        PreferredAuthenticationMethod: 'STRING_VALUE',
        Priority: 'STRING_VALUE',
        RawContent: 'STRING_VALUE',
        SilentPush: true || false,
        Sound: 'STRING_VALUE',
        Substitutions: {
          '<__string>': [
            'STRING_VALUE',
            /* more items */
          ],
          /* '<__string>': ... */
        },
        ThreadId: 'STRING_VALUE',
        TimeToLive: 'NUMBER_VALUE',
        Title: 'STRING_VALUE',
        Url: 'STRING_VALUE'
      },
      BaiduMessage: {
        Action: OPEN_APP | DEEP_LINK | URL,
        Body: 'STRING_VALUE',
        Data: {
          '<__string>': 'STRING_VALUE',
          /* '<__string>': ... */
        },
        IconReference: 'STRING_VALUE',
        ImageIconUrl: 'STRING_VALUE',
        ImageUrl: 'STRING_VALUE',
        RawContent: 'STRING_VALUE',
        SilentPush: true || false,
        SmallImageIconUrl: 'STRING_VALUE',
        Sound: 'STRING_VALUE',
        Substitutions: {
          '<__string>': [
            'STRING_VALUE',
            /* more items */
          ],
          /* '<__string>': ... */
        },
        TimeToLive: 'NUMBER_VALUE',
        Title: 'STRING_VALUE',
        Url: 'STRING_VALUE'
      },
      DefaultMessage: {
        Body: 'STRING_VALUE',
        Substitutions: {
          '<__string>': [
            'STRING_VALUE',
            /* more items */
          ],
          /* '<__string>': ... */
        }
      },
      DefaultPushNotificationMessage: {
        Action: OPEN_APP | DEEP_LINK | URL,
        Body: 'STRING_VALUE',
        Data: {
          '<__string>': 'STRING_VALUE',
          /* '<__string>': ... */
        },
        SilentPush: true || false,
        Substitutions: {
          '<__string>': [
            'STRING_VALUE',
            /* more items */
          ],
          /* '<__string>': ... */
        },
        Title: 'STRING_VALUE',
        Url: 'STRING_VALUE'
      },
      EmailMessage: {
        Body: 'STRING_VALUE',
        FeedbackForwardingAddress: 'STRING_VALUE',
        FromAddress: 'STRING_VALUE',
        RawEmail: {
          Data: new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */
        },
        ReplyToAddresses: [
          'STRING_VALUE',
          /* more items */
        ],
        SimpleEmail: {
          HtmlPart: {
            Charset: 'STRING_VALUE',
            Data: 'STRING_VALUE'
          },
          Subject: {
            Charset: 'STRING_VALUE',
            Data: 'STRING_VALUE'
          },
          TextPart: {
            Charset: 'STRING_VALUE',
            Data: 'STRING_VALUE'
          }
        },
        Substitutions: {
          '<__string>': [
            'STRING_VALUE',
            /* more items */
          ],
          /* '<__string>': ... */
        }
      },
      GCMMessage: {
        Action: OPEN_APP | DEEP_LINK | URL,
        Body: 'STRING_VALUE',
        CollapseKey: 'STRING_VALUE',
        Data: {
          '<__string>': 'STRING_VALUE',
          /* '<__string>': ... */
        },
        IconReference: 'STRING_VALUE',
        ImageIconUrl: 'STRING_VALUE',
        ImageUrl: 'STRING_VALUE',
        Priority: 'STRING_VALUE',
        RawContent: 'STRING_VALUE',
        RestrictedPackageName: 'STRING_VALUE',
        SilentPush: true || false,
        SmallImageIconUrl: 'STRING_VALUE',
        Sound: 'STRING_VALUE',
        Substitutions: {
          '<__string>': [
            'STRING_VALUE',
            /* more items */
          ],
          /* '<__string>': ... */
        },
        TimeToLive: 'NUMBER_VALUE',
        Title: 'STRING_VALUE',
        Url: 'STRING_VALUE'
      },
      SMSMessage: {
        Body: 'STRING_VALUE',
        Keyword: 'STRING_VALUE',
        MessageType: TRANSACTIONAL | PROMOTIONAL,
        OriginationNumber: 'STRING_VALUE',
        SenderId: 'STRING_VALUE',
        Substitutions: {
          '<__string>': [
            'STRING_VALUE',
            /* more items */
          ],
          /* '<__string>': ... */
        }
      },
      VoiceMessage: {
        Body: 'STRING_VALUE',
        LanguageCode: 'STRING_VALUE',
        OriginationNumber: 'STRING_VALUE',
        Substitutions: {
          '<__string>': [
            'STRING_VALUE',
            /* more items */
          ],
          /* '<__string>': ... */
        },
        VoiceId: 'STRING_VALUE'
      }
    },
    TraceId: 'STRING_VALUE',
    Users: {
      '<__string>': {
        BodyOverride: 'STRING_VALUE',
        Context: {
          '<__string>': 'STRING_VALUE',
          /* '<__string>': ... */
        },
        RawContent: 'STRING_VALUE',
        Substitutions: {
          '<__string>': [
            'STRING_VALUE',
            /* more items */
          ],
          /* '<__string>': ... */
        },
        TitleOverride: 'STRING_VALUE'
      },
      /* '<__string>': ... */
    }
  }
};
pinpoint.sendUsersMessages(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.
    • SendUsersMessageRequest — (map) Send message request.
      • Context — (map<String>) A map of custom attribute-value pairs. Amazon Pinpoint adds these attributes to the data.pinpoint object in the body of the push notification payload. Amazon Pinpoint also provides these attributes in the events that it generates for users-messages deliveries.
      • MessageConfiguration — (map) Message definitions for the default message and any messages that are tailored for specific channels.
        • ADMMessage — (map) The message to ADM channels. Overrides the default push notification 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. Possible values include: OPEN_APP | DEEP_LINK | URL Possible values include:
            • "OPEN_APP"
            • "DEEP_LINK"
            • "URL"
          • Body — (String) The message body of the notification.
          • ConsolidationKey — (String) Optional. Arbitrary string used to indicate multiple messages are logically the same and that ADM is allowed to drop previously enqueued messages in favor of this one.
          • Data — (map<String>) The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
          • ExpiresAfter — (String) Optional. Number of seconds ADM should retain the message if the device is offline
          • IconReference — (String) The icon image name of the asset saved in your application.
          • ImageIconUrl — (String) The URL that points to an image used as the large icon to the notification content view.
          • ImageUrl — (String) The URL that points to an image used in the push notification.
          • MD5 — (String) Optional. Base-64-encoded MD5 checksum of the data parameter. Used to verify data integrity
          • 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.
          • SmallImageIconUrl — (String) The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view
          • Sound — (String) Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/
          • Substitutions — (map<Array<String>>) Default message substitutions. Can be overridden by individual address substitutions.
          • 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 — (map) The message to APNS channels. Overrides the default push notification 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. Possible values include: OPEN_APP | DEEP_LINK | URL Possible values include:
            • "OPEN_APP"
            • "DEEP_LINK"
            • "URL"
          • Badge — (Integer) Include this key when you want the system to modify the badge of your app icon. If this key is not included in the dictionary, the badge is not changed. To remove the badge, set the value of this key to 0.
          • Body — (String) The message body of the notification.
          • Category — (String) Provide this key with a string value that represents the notification's type. This value corresponds to the value in the identifier property of one of your app's registered categories.
          • CollapseId — (String) An ID that, if assigned to multiple messages, causes APNs to coalesce the messages into a single push notification instead of delivering each message individually. The value must not exceed 64 bytes. Amazon Pinpoint uses this value to set the apns-collapse-id request header when it sends the message to APNs.
          • Data — (map<String>) The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
          • MediaUrl — (String) A URL that refers to the location of an image or video that you want to display in the push notification.
          • PreferredAuthenticationMethod — (String) The preferred authentication method, either "CERTIFICATE" or "TOKEN"
          • Priority — (String) The message priority. Amazon Pinpoint uses this value to set the apns-priority request header when it sends the message to APNs. Accepts the following values: "5" - Low priority. Messages might be delayed, delivered in groups, and throttled. "10" - High priority. Messages are sent immediately. High priority messages must cause an alert, sound, or badge on the receiving device. The default value is "10". The equivalent values for FCM or GCM messages are "normal" and "high". Amazon Pinpoint accepts these values for APNs messages and converts them. For more information about the apns-priority parameter, see Communicating with APNs in the APNs Local and Remote Notification Programming Guide.
          • 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.
          • Sound — (String) Include this key when you want the system to play a sound. The value of this key is the name of a sound file in your app's main bundle or in the Library/Sounds folder of your app's data container. If the sound file cannot be found, or if you specify defaultfor the value, the system plays the default alert sound.
          • Substitutions — (map<Array<String>>) Default message substitutions. Can be overridden by individual address substitutions.
          • ThreadId — (String) Provide this key with a string value that represents the app-specific identifier for grouping notifications. If you provide a Notification Content app extension, you can use this value to group your notifications together.
          • TimeToLive — (Integer) The length of time (in seconds) that APNs stores and attempts to deliver the message. If the value is 0, APNs does not store the message or attempt to deliver it more than once. Amazon Pinpoint uses this value to set the apns-expiration request header when it sends the message to APNs.
          • 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 — (map) The message to Baidu GCM channels. Overrides the default push notification 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. Possible values include: OPEN_APP | DEEP_LINK | URL Possible values include:
            • "OPEN_APP"
            • "DEEP_LINK"
            • "URL"
          • Body — (String) The message body of the notification.
          • Data — (map<String>) The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
          • IconReference — (String) The icon image name of the asset saved in your application.
          • ImageIconUrl — (String) The URL that points to an image used as the large icon to the notification content view.
          • ImageUrl — (String) The URL that points to an image used 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.
          • SmallImageIconUrl — (String) The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view
          • Sound — (String) Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/
          • Substitutions — (map<Array<String>>) Default message substitutions. Can be overridden by individual address substitutions.
          • TimeToLive — (Integer) This parameter specifies how long (in seconds) the message should be kept in Baidu storage if the device is offline. The and the default value and the maximum time to live supported is 7 days (604800 seconds)
          • 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 — (map) The default message for all channels.
          • Body — (String) The message body of the notification, the email body or the text message.
          • Substitutions — (map<Array<String>>) Default message substitutions. Can be overridden by individual address substitutions.
        • DefaultPushNotificationMessage — (map) The default push notification message for all push 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. Possible values include: OPEN_APP | DEEP_LINK | URL Possible values include:
            • "OPEN_APP"
            • "DEEP_LINK"
            • "URL"
          • Body — (String) The message body of the notification.
          • Data — (map<String>) The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
          • SilentPush — (Boolean) Indicates if the message should display on the recipient's device. You can use silent pushes for remote configuration or to deliver messages to in-app notification centers.
          • Substitutions — (map<Array<String>>) Default message substitutions. Can be overridden by individual address substitutions.
          • 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 — (map) The message to Email channels. Overrides the default message.
          • Body — (String) The body of the email message.
          • FeedbackForwardingAddress — (String) The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled.
          • FromAddress — (String) The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.
          • RawEmail — (map) An email represented as a raw MIME message.
            • Data — (Buffer, Typed Array, Blob, String) The raw email message itself. Then entire message must be base64-encoded.
          • ReplyToAddresses — (Array<String>) The reply-to email address(es) for the email. If the recipient replies to the email, each reply-to address will receive the reply.
          • SimpleEmail — (map) An email composed of a subject, a text part and a html part.
            • HtmlPart — (map) The content of the message, in HTML format. Use this for email clients that can process HTML. You can include clickable links, formatted text, and much more in an HTML message.
              • Charset — (String) The character set of the content.
              • Data — (String) The textual data of the content.
            • Subject — (map) The subject of the message: A short summary of the content, which will appear in the recipient's inbox.
              • Charset — (String) The character set of the content.
              • Data — (String) The textual data of the content.
            • TextPart — (map) The content of the message, in text format. Use this for text-based email clients, or clients on high-latency networks (such as mobile devices).
              • Charset — (String) The character set of the content.
              • Data — (String) The textual data of the content.
          • Substitutions — (map<Array<String>>) Default message substitutions. Can be overridden by individual address substitutions.
        • GCMMessage — (map) The message to GCM channels. Overrides the default push notification 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. Possible values include: OPEN_APP | DEEP_LINK | URL Possible values include:
            • "OPEN_APP"
            • "DEEP_LINK"
            • "URL"
          • Body — (String) The message body of the notification.
          • CollapseKey — (String) This parameter identifies a group of messages (e.g., with collapse_key: "Updates Available") that can be collapsed, so that only the last message gets sent when delivery can be resumed. This is intended to avoid sending too many of the same messages when the device comes back online or becomes active.
          • Data — (map<String>) The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object
          • IconReference — (String) The icon image name of the asset saved in your application.
          • ImageIconUrl — (String) The URL that points to an image used as the large icon to the notification content view.
          • ImageUrl — (String) The URL that points to an image used in the push notification.
          • Priority — (String) The message priority. Amazon Pinpoint uses this value to set the FCM or GCM priority parameter when it sends the message. Accepts the following values: "Normal" - Messages might be delayed. Delivery is optimized for battery usage on the receiving device. Use normal priority unless immediate delivery is required. "High" - Messages are sent immediately and might wake a sleeping device. The equivalent values for APNs messages are "5" and "10". Amazon Pinpoint accepts these values here and converts them. For more information, see About FCM Messages in the Firebase documentation.
          • RawContent — (String) The Raw JSON formatted string to be used as the payload. This value overrides the message.
          • RestrictedPackageName — (String) This parameter specifies the package name of the application where the registration tokens must match in order to receive 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.
          • SmallImageIconUrl — (String) The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view
          • Sound — (String) Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/
          • Substitutions — (map<Array<String>>) Default message substitutions. Can be overridden by individual address substitutions.
          • TimeToLive — (Integer) The length of time (in seconds) that FCM or GCM stores and attempts to deliver the message. If unspecified, the value defaults to the maximum, which is 2,419,200 seconds (28 days). Amazon Pinpoint uses this value to set the FCM or GCM time_to_live parameter.
          • 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 — (map) The message to SMS channels. Overrides the default message.
          • Body — (String) The body of the SMS message.
          • Keyword — (String) The SMS program name that you provided to AWS Support when you requested your dedicated number.
          • MessageType — (String) Is this a transaction priority message or lower priority. Possible values include:
            • "TRANSACTIONAL"
            • "PROMOTIONAL"
          • OriginationNumber — (String) The phone number that the SMS message originates from. Specify one of the dedicated long codes or short codes that you requested from AWS Support and that is assigned to your account. If this attribute is not specified, Amazon Pinpoint randomly assigns a long code.
          • SenderId — (String) The sender ID that is shown as the message sender on the recipient's device. Support for sender IDs varies by country or region.
          • Substitutions — (map<Array<String>>) Default message substitutions. Can be overridden by individual address substitutions.
        • VoiceMessage — (map) The message to Voice channels. Overrides the default message.
          • Body — (String) The message body of the notification, the email body or the text message.
          • LanguageCode — (String) Language of sent message
          • OriginationNumber — (String) Is the number from the pool or messaging service to send from.
          • Substitutions — (map<Array<String>>) Default message substitutions. Can be overridden by individual address substitutions.
          • VoiceId — (String) Voice ID of sent message.
      • TraceId — (String) A unique ID that you can use to trace a message. This ID is visible to recipients.
      • Users — (map<map>) A map that associates user IDs with EndpointSendConfiguration objects. Within an EndpointSendConfiguration object, you can tailor the message for a user by specifying message overrides or substitutions.
        • BodyOverride — (String) Body override. If specified will override default body.
        • Context — (map<String>) A map of custom attributes to attributes to be attached to the message for this address. This payload is added to the push notification's 'data.pinpoint' object or added to the email/sms delivery receipt event attributes.
        • RawContent — (String) The Raw JSON formatted string to be used as the payload. This value overrides the message.
        • Substitutions — (map<Array<String>>) A map of substitution values for the message to be merged with the DefaultMessage's substitutions. Substitutions on this map take precedence over the all other substitutions.
        • TitleOverride — (String) Title override. If specified will override default title if applicable.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SendUsersMessageResponse — (map) User send message response.
        • ApplicationId — (String) The unique ID of the Amazon Pinpoint project used to send the message.
        • RequestId — (String) The unique ID assigned to the users-messages request.
        • Result — (map<map<map>>) An object that shows the endpoints that were messaged for each user. The object provides a list of user IDs. For each user ID, it provides the endpoint IDs that were messaged. For each endpoint ID, it provides an EndpointMessageResult object.
          • Address — (String) Address that endpoint message was delivered to.
          • DeliveryStatus — (String) The delivery status of the message. Possible values: SUCCESS - The message was successfully delivered to the endpoint. TRANSIENT_FAILURE - A temporary error occurred. Amazon Pinpoint will attempt to deliver the message again later. FAILURE_PERMANENT - An error occurred when delivering the message to the endpoint. Amazon Pinpoint won't attempt to send the message again. TIMEOUT - The message couldn't be sent within the timeout period. QUIET_TIME - The local time for the endpoint was within the QuietTime for the campaign or app. DAILY_CAP - The endpoint has received the maximum number of messages it can receive within a 24-hour period. HOLDOUT - The endpoint was in a hold out treatment for the campaign. THROTTLED - Amazon Pinpoint throttled sending to this endpoint. EXPIRED - The endpoint address is expired. CAMPAIGN_CAP - The endpoint received the maximum number of messages allowed by the campaign. SERVICE_FAILURE - A service-level failure prevented Amazon Pinpoint from delivering the message. UNKNOWN - An unknown error occurred. Possible values include:
            • "SUCCESSFUL"
            • "THROTTLED"
            • "TEMPORARY_FAILURE"
            • "PERMANENT_FAILURE"
            • "UNKNOWN_FAILURE"
            • "OPT_OUT"
            • "DUPLICATE"
          • MessageId — (String) Unique message identifier associated with the message that was sent.
          • StatusCode — (Integer) Downstream service status code.
          • StatusMessage — (String) Status message for message delivery.
          • UpdatedToken — (String) If token was updated as part of delivery. (This is GCM Specific)

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

Calls the TagResource API operation.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagsModel: { /* required */
    tags: { /* required */
      '<__string>': 'STRING_VALUE',
      /* '<__string>': ... */
    }
  }
};
pinpoint.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)
    • TagsModel — (map)
      • tags — required — (map<String>)

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

Calls the UntagResource API operation.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
pinpoint.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)
    • TagKeys — (Array<String>) The key(s) of tag to be deleted

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateAdmChannel(params = {}, callback) ⇒ AWS.Request

Update an ADM channel.

Service Reference:

Examples:

Calling the updateAdmChannel operation

var params = {
  ADMChannelRequest: { /* required */
    ClientId: 'STRING_VALUE',
    ClientSecret: 'STRING_VALUE',
    Enabled: true || false
  },
  ApplicationId: 'STRING_VALUE' /* required */
};
pinpoint.updateAdmChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ADMChannelRequest — (map) Amazon Device Messaging channel definition.
      • ClientId — (String) The Client ID that you obtained from the Amazon App Distribution Portal.
      • ClientSecret — (String) The Client Secret that you obtained from the Amazon App Distribution Portal.
      • Enabled — (Boolean) Indicates whether or not the channel is enabled for sending messages.
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ADMChannelResponse — (map) Amazon Device Messaging channel definition.
        • ApplicationId — (String) The ID of the application to which the channel applies.
        • CreationDate — (String) The date and time when this channel was created.
        • Enabled — (Boolean) Indicates whether or not the channel is enabled for sending messages.
        • HasCredential — (Boolean) Not used. Retained for backwards compatibility.
        • Id — (String) (Deprecated) An identifier for the channel. Retained for backwards compatibility.
        • IsArchived — (Boolean) Indicates whether or not the channel is archived.
        • LastModifiedBy — (String) The user who last updated this channel.
        • LastModifiedDate — (String) The date and time when this channel was last modified.
        • Platform — (String) The platform type. For this channel, the value is always "ADM."
        • Version — (Integer) The channel version.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateApnsChannel(params = {}, callback) ⇒ AWS.Request

Use to update the APNs channel for an app.

Service Reference:

Examples:

Calling the updateApnsChannel operation

var params = {
  APNSChannelRequest: { /* required */
    BundleId: 'STRING_VALUE',
    Certificate: 'STRING_VALUE',
    DefaultAuthenticationMethod: 'STRING_VALUE',
    Enabled: true || false,
    PrivateKey: 'STRING_VALUE',
    TeamId: 'STRING_VALUE',
    TokenKey: 'STRING_VALUE',
    TokenKeyId: 'STRING_VALUE'
  },
  ApplicationId: 'STRING_VALUE' /* required */
};
pinpoint.updateApnsChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • APNSChannelRequest — (map) Apple Push Notification Service channel definition.
      • BundleId — (String) The bundle id used for APNs Tokens.
      • Certificate — (String) The distribution certificate from Apple.
      • DefaultAuthenticationMethod — (String) The default authentication method used for APNs.
      • Enabled — (Boolean) If the channel is enabled for sending messages.
      • PrivateKey — (String) The certificate private key.
      • TeamId — (String) The team id used for APNs Tokens.
      • TokenKey — (String) The token key used for APNs Tokens.
      • TokenKeyId — (String) The token key used for APNs Tokens.
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • APNSChannelResponse — (map) Apple Distribution Push Notification Service channel definition.
        • ApplicationId — (String) The ID of the application that the channel applies to.
        • CreationDate — (String) The date and time when this channel was created.
        • DefaultAuthenticationMethod — (String) The default authentication method used for APNs.
        • Enabled — (Boolean) If the channel is enabled for sending messages.
        • HasCredential — (Boolean) Not used. Retained for backwards compatibility.
        • HasTokenKey — (Boolean) Indicates whether the channel is configured with a key for APNs token authentication. Provide a token key by setting the TokenKey attribute.
        • Id — (String) (Deprecated) An identifier for the channel. Retained for backwards compatibility.
        • IsArchived — (Boolean) Indicates whether or not the channel is archived.
        • LastModifiedBy — (String) The user who last updated this channel.
        • LastModifiedDate — (String) The date and time when this channel was last modified.
        • Platform — (String) The platform type. For this channel, the value is always "ADM."
        • Version — (Integer) The channel version.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateApnsSandboxChannel(params = {}, callback) ⇒ AWS.Request

Update an APNS sandbox channel.

Service Reference:

Examples:

Calling the updateApnsSandboxChannel operation

var params = {
  APNSSandboxChannelRequest: { /* required */
    BundleId: 'STRING_VALUE',
    Certificate: 'STRING_VALUE',
    DefaultAuthenticationMethod: 'STRING_VALUE',
    Enabled: true || false,
    PrivateKey: 'STRING_VALUE',
    TeamId: 'STRING_VALUE',
    TokenKey: 'STRING_VALUE',
    TokenKeyId: 'STRING_VALUE'
  },
  ApplicationId: 'STRING_VALUE' /* required */
};
pinpoint.updateApnsSandboxChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • APNSSandboxChannelRequest — (map) Apple Development Push Notification Service channel definition.
      • BundleId — (String) The bundle id used for APNs Tokens.
      • Certificate — (String) The distribution certificate from Apple.
      • DefaultAuthenticationMethod — (String) The default authentication method used for APNs.
      • Enabled — (Boolean) If the channel is enabled for sending messages.
      • PrivateKey — (String) The certificate private key.
      • TeamId — (String) The team id used for APNs Tokens.
      • TokenKey — (String) The token key used for APNs Tokens.
      • TokenKeyId — (String) The token key used for APNs Tokens.
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • APNSSandboxChannelResponse — (map) Apple Development Push Notification Service channel definition.
        • ApplicationId — (String) The ID of the application to which the channel applies.
        • CreationDate — (String) When was this segment created
        • DefaultAuthenticationMethod — (String) The default authentication method used for APNs.
        • Enabled — (Boolean) If the channel is enabled for sending messages.
        • HasCredential — (Boolean) Not used. Retained for backwards compatibility.
        • HasTokenKey — (Boolean) Indicates whether the channel is configured with a key for APNs token authentication. Provide a token key by setting the TokenKey attribute.
        • Id — (String) Channel ID. Not used, only for backwards compatibility.
        • IsArchived — (Boolean) Is this channel archived
        • LastModifiedBy — (String) Who last updated this entry
        • LastModifiedDate — (String) Last date this was updated
        • Platform — (String) The platform type. Will be APNS_SANDBOX.
        • Version — (Integer) Version of channel

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateApnsVoipChannel(params = {}, callback) ⇒ AWS.Request

Update an APNS VoIP channel

Service Reference:

Examples:

Calling the updateApnsVoipChannel operation

var params = {
  APNSVoipChannelRequest: { /* required */
    BundleId: 'STRING_VALUE',
    Certificate: 'STRING_VALUE',
    DefaultAuthenticationMethod: 'STRING_VALUE',
    Enabled: true || false,
    PrivateKey: 'STRING_VALUE',
    TeamId: 'STRING_VALUE',
    TokenKey: 'STRING_VALUE',
    TokenKeyId: 'STRING_VALUE'
  },
  ApplicationId: 'STRING_VALUE' /* required */
};
pinpoint.updateApnsVoipChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • APNSVoipChannelRequest — (map) Apple VoIP Push Notification Service channel definition.
      • BundleId — (String) The bundle id used for APNs Tokens.
      • Certificate — (String) The distribution certificate from Apple.
      • DefaultAuthenticationMethod — (String) The default authentication method used for APNs.
      • Enabled — (Boolean) If the channel is enabled for sending messages.
      • PrivateKey — (String) The certificate private key.
      • TeamId — (String) The team id used for APNs Tokens.
      • TokenKey — (String) The token key used for APNs Tokens.
      • TokenKeyId — (String) The token key used for APNs Tokens.
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • APNSVoipChannelResponse — (map) Apple VoIP Push Notification Service channel definition.
        • ApplicationId — (String) Application id
        • CreationDate — (String) When was this segment created
        • DefaultAuthenticationMethod — (String) The default authentication method used for APNs.
        • Enabled — (Boolean) If the channel is enabled for sending messages.
        • HasCredential — (Boolean) Not used. Retained for backwards compatibility.
        • HasTokenKey — (Boolean) If the channel is registered with a token key for authentication.
        • Id — (String) Channel ID. Not used, only for backwards compatibility.
        • IsArchived — (Boolean) Is this channel archived
        • LastModifiedBy — (String) Who made the last change
        • LastModifiedDate — (String) Last date this was updated
        • Platform — (String) The platform type. Will be APNS.
        • Version — (Integer) Version of channel

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateApnsVoipSandboxChannel(params = {}, callback) ⇒ AWS.Request

Update an APNS VoIP sandbox channel

Service Reference:

Examples:

Calling the updateApnsVoipSandboxChannel operation

var params = {
  APNSVoipSandboxChannelRequest: { /* required */
    BundleId: 'STRING_VALUE',
    Certificate: 'STRING_VALUE',
    DefaultAuthenticationMethod: 'STRING_VALUE',
    Enabled: true || false,
    PrivateKey: 'STRING_VALUE',
    TeamId: 'STRING_VALUE',
    TokenKey: 'STRING_VALUE',
    TokenKeyId: 'STRING_VALUE'
  },
  ApplicationId: 'STRING_VALUE' /* required */
};
pinpoint.updateApnsVoipSandboxChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • APNSVoipSandboxChannelRequest — (map) Apple VoIP Developer Push Notification Service channel definition.
      • BundleId — (String) The bundle id used for APNs Tokens.
      • Certificate — (String) The distribution certificate from Apple.
      • DefaultAuthenticationMethod — (String) The default authentication method used for APNs.
      • Enabled — (Boolean) If the channel is enabled for sending messages.
      • PrivateKey — (String) The certificate private key.
      • TeamId — (String) The team id used for APNs Tokens.
      • TokenKey — (String) The token key used for APNs Tokens.
      • TokenKeyId — (String) The token key used for APNs Tokens.
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • APNSVoipSandboxChannelResponse — (map) Apple VoIP Developer Push Notification Service channel definition.
        • ApplicationId — (String) Application id
        • CreationDate — (String) When was this segment created
        • DefaultAuthenticationMethod — (String) The default authentication method used for APNs.
        • Enabled — (Boolean) If the channel is enabled for sending messages.
        • HasCredential — (Boolean) Not used. Retained for backwards compatibility.
        • HasTokenKey — (Boolean) If the channel is registered with a token key for authentication.
        • Id — (String) Channel ID. Not used, only for backwards compatibility.
        • IsArchived — (Boolean) Is this channel archived
        • LastModifiedBy — (String) Who made the last change
        • LastModifiedDate — (String) Last date this was updated
        • Platform — (String) The platform type. Will be APNS.
        • Version — (Integer) Version of channel

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateApplicationSettings(params = {}, callback) ⇒ AWS.Request

Used to update the settings for an app.

Service Reference:

Examples:

Calling the updateApplicationSettings operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  WriteApplicationSettingsRequest: { /* required */
    CampaignHook: {
      LambdaFunctionName: 'STRING_VALUE',
      Mode: DELIVERY | FILTER,
      WebUrl: 'STRING_VALUE'
    },
    CloudWatchMetricsEnabled: true || false,
    Limits: {
      Daily: 'NUMBER_VALUE',
      MaximumDuration: 'NUMBER_VALUE',
      MessagesPerSecond: 'NUMBER_VALUE',
      Total: 'NUMBER_VALUE'
    },
    QuietTime: {
      End: 'STRING_VALUE',
      Start: 'STRING_VALUE'
    }
  }
};
pinpoint.updateApplicationSettings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.
    • WriteApplicationSettingsRequest — (map) Creating application setting request
      • CampaignHook — (map) Default campaign hook information.
        • LambdaFunctionName — (String) Lambda function name or arn to be called for delivery
        • Mode — (String) What mode Lambda should be invoked in. Possible values include:
          • "DELIVERY"
          • "FILTER"
        • WebUrl — (String) Web URL to call for hook. If the URL has authentication specified it will be added as authentication to the request
      • CloudWatchMetricsEnabled — (Boolean) The CloudWatchMetrics settings for the app.
      • Limits — (map) The limits that apply to each campaign in the project by default. Campaigns can also have their own limits, which override the settings at the project level.
        • 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.
      • QuietTime — (map) The default quiet time for the app. Campaigns in the app don'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 app. 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 an app to use quiet time, campaigns in that app don'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 app (or campaign, if applicable). - 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 app (or campaign, if applicable). Individual campaigns within the app can have their own quiet time settings, which override the quiet time settings at the app level.
        • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationSettingsResource — (map) Application settings.
        • ApplicationId — (String) The unique ID for the application.
        • CampaignHook — (map) Default campaign hook.
          • LambdaFunctionName — (String) Lambda function name or arn to be called for delivery
          • Mode — (String) What mode Lambda should be invoked in. Possible values include:
            • "DELIVERY"
            • "FILTER"
          • WebUrl — (String) Web URL to call for hook. If the URL has authentication specified it will be added as authentication to the request
        • LastModifiedDate — (String) The date that the settings were last updated in ISO 8601 format.
        • Limits — (map) The default campaign limits for the app. These limits apply to each campaign for the app, unless the campaign overrides the default with limits of its own.
          • 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.
        • QuietTime — (map) The default quiet time for the app. Campaigns in the app don'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 app. 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 an app to use quiet time, campaigns in that app don'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 app (or campaign, if applicable). - 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 app (or campaign, if applicable). Individual campaigns within the app can have their own quiet time settings, which override the quiet time settings at the app level.
          • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateBaiduChannel(params = {}, callback) ⇒ AWS.Request

Update a BAIDU GCM channel

Service Reference:

Examples:

Calling the updateBaiduChannel operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  BaiduChannelRequest: { /* required */
    ApiKey: 'STRING_VALUE',
    Enabled: true || false,
    SecretKey: 'STRING_VALUE'
  }
};
pinpoint.updateBaiduChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.
    • BaiduChannelRequest — (map) Baidu Cloud Push credentials
      • ApiKey — (String) Platform credential API key from Baidu.
      • Enabled — (Boolean) If the channel is enabled for sending messages.
      • SecretKey — (String) Platform credential Secret key from Baidu.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BaiduChannelResponse — (map) Baidu Cloud Messaging channel definition
        • ApplicationId — (String) Application id
        • CreationDate — (String) When was this segment created
        • Credential — (String) The Baidu API key from Baidu.
        • Enabled — (Boolean) If the channel is enabled for sending messages.
        • HasCredential — (Boolean) Not used. Retained for backwards compatibility.
        • Id — (String) Channel ID. Not used, only for backwards compatibility.
        • IsArchived — (Boolean) Is this channel archived
        • LastModifiedBy — (String) Who made the last change
        • LastModifiedDate — (String) Last date this was updated
        • Platform — (String) The platform type. Will be BAIDU
        • Version — (Integer) Version of channel

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateCampaign(params = {}, callback) ⇒ AWS.Request

Use to update a campaign.

Service Reference:

Examples:

Calling the updateCampaign operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  CampaignId: 'STRING_VALUE', /* required */
  WriteCampaignRequest: { /* required */
    AdditionalTreatments: [
      {
        MessageConfiguration: {
          ADMMessage: {
            Action: OPEN_APP | DEEP_LINK | URL,
            Body: 'STRING_VALUE',
            ImageIconUrl: 'STRING_VALUE',
            ImageSmallIconUrl: 'STRING_VALUE',
            ImageUrl: 'STRING_VALUE',
            JsonBody: 'STRING_VALUE',
            MediaUrl: 'STRING_VALUE',
            RawContent: 'STRING_VALUE',
            SilentPush: true || false,
            TimeToLive: 'NUMBER_VALUE',
            Title: 'STRING_VALUE',
            Url: 'STRING_VALUE'
          },
          APNSMessage: {
            Action: OPEN_APP | DEEP_LINK | URL,
            Body: 'STRING_VALUE',
            ImageIconUrl: 'STRING_VALUE',
            ImageSmallIconUrl: 'STRING_VALUE',
            ImageUrl: 'STRING_VALUE',
            JsonBody: 'STRING_VALUE',
            MediaUrl: 'STRING_VALUE',
            RawContent: 'STRING_VALUE',
            SilentPush: true || false,
            TimeToLive: 'NUMBER_VALUE',
            Title: 'STRING_VALUE',
            Url: 'STRING_VALUE'
          },
          BaiduMessage: {
            Action: OPEN_APP | DEEP_LINK | URL,
            Body: 'STRING_VALUE',
            ImageIconUrl: 'STRING_VALUE',
            ImageSmallIconUrl: 'STRING_VALUE',
            ImageUrl: 'STRING_VALUE',
            JsonBody: 'STRING_VALUE',
            MediaUrl: 'STRING_VALUE',
            RawContent: 'STRING_VALUE',
            SilentPush: true || false,
            TimeToLive: 'NUMBER_VALUE',
            Title: 'STRING_VALUE',
            Url: 'STRING_VALUE'
          },
          DefaultMessage: {
            Action: OPEN_APP | DEEP_LINK | URL,
            Body: 'STRING_VALUE',
            ImageIconUrl: 'STRING_VALUE',
            ImageSmallIconUrl: 'STRING_VALUE',
            ImageUrl: 'STRING_VALUE',
            JsonBody: 'STRING_VALUE',
            MediaUrl: 'STRING_VALUE',
            RawContent: 'STRING_VALUE',
            SilentPush: true || false,
            TimeToLive: 'NUMBER_VALUE',
            Title: 'STRING_VALUE',
            Url: 'STRING_VALUE'
          },
          EmailMessage: {
            Body: 'STRING_VALUE',
            FromAddress: 'STRING_VALUE',
            HtmlBody: 'STRING_VALUE',
            Title: 'STRING_VALUE'
          },
          GCMMessage: {
            Action: OPEN_APP | DEEP_LINK | URL,
            Body: 'STRING_VALUE',
            ImageIconUrl: 'STRING_VALUE',
            ImageSmallIconUrl: 'STRING_VALUE',
            ImageUrl: 'STRING_VALUE',
            JsonBody: 'STRING_VALUE',
            MediaUrl: 'STRING_VALUE',
            RawContent: 'STRING_VALUE',
            SilentPush: true || false,
            TimeToLive: 'NUMBER_VALUE',
            Title: 'STRING_VALUE',
            Url: 'STRING_VALUE'
          },
          SMSMessage: {
            Body: 'STRING_VALUE',
            MessageType: TRANSACTIONAL | PROMOTIONAL,
            SenderId: 'STRING_VALUE'
          }
        },
        Schedule: {
          EndTime: 'STRING_VALUE',
          EventFilter: {
            Dimensions: {
              Attributes: {
                '<__string>': {
                  AttributeType: INCLUSIVE | EXCLUSIVE,
                  Values: [
                    'STRING_VALUE',
                    /* more items */
                  ]
                },
                /* '<__string>': ... */
              },
              EventType: {
                DimensionType: INCLUSIVE | EXCLUSIVE,
                Values: [
                  'STRING_VALUE',
                  /* more items */
                ]
              },
              Metrics: {
                '<__string>': {
                  ComparisonOperator: 'STRING_VALUE',
                  Value: 'NUMBER_VALUE'
                },
                /* '<__string>': ... */
              }
            },
            FilterType: SYSTEM | ENDPOINT
          },
          Frequency: ONCE | HOURLY | DAILY | WEEKLY | MONTHLY | EVENT,
          IsLocalTime: true || false,
          QuietTime: {
            End: 'STRING_VALUE',
            Start: 'STRING_VALUE'
          },
          StartTime: 'STRING_VALUE',
          Timezone: 'STRING_VALUE'
        },
        SizePercent: 'NUMBER_VALUE',
        TreatmentDescription: 'STRING_VALUE',
        TreatmentName: 'STRING_VALUE'
      },
      /* more items */
    ],
    Description: 'STRING_VALUE',
    HoldoutPercent: 'NUMBER_VALUE',
    Hook: {
      LambdaFunctionName: 'STRING_VALUE',
      Mode: DELIVERY | FILTER,
      WebUrl: 'STRING_VALUE'
    },
    IsPaused: true || false,
    Limits: {
      Daily: 'NUMBER_VALUE',
      MaximumDuration: 'NUMBER_VALUE',
      MessagesPerSecond: 'NUMBER_VALUE',
      Total: 'NUMBER_VALUE'
    },
    MessageConfiguration: {
      ADMMessage: {
        Action: OPEN_APP | DEEP_LINK | URL,
        Body: 'STRING_VALUE',
        ImageIconUrl: 'STRING_VALUE',
        ImageSmallIconUrl: 'STRING_VALUE',
        ImageUrl: 'STRING_VALUE',
        JsonBody: 'STRING_VALUE',
        MediaUrl: 'STRING_VALUE',
        RawContent: 'STRING_VALUE',
        SilentPush: true || false,
        TimeToLive: 'NUMBER_VALUE',
        Title: 'STRING_VALUE',
        Url: 'STRING_VALUE'
      },
      APNSMessage: {
        Action: OPEN_APP | DEEP_LINK | URL,
        Body: 'STRING_VALUE',
        ImageIconUrl: 'STRING_VALUE',
        ImageSmallIconUrl: 'STRING_VALUE',
        ImageUrl: 'STRING_VALUE',
        JsonBody: 'STRING_VALUE',
        MediaUrl: 'STRING_VALUE',
        RawContent: 'STRING_VALUE',
        SilentPush: true || false,
        TimeToLive: 'NUMBER_VALUE',
        Title: 'STRING_VALUE',
        Url: 'STRING_VALUE'
      },
      BaiduMessage: {
        Action: OPEN_APP | DEEP_LINK | URL,
        Body: 'STRING_VALUE',
        ImageIconUrl: 'STRING_VALUE',
        ImageSmallIconUrl: 'STRING_VALUE',
        ImageUrl: 'STRING_VALUE',
        JsonBody: 'STRING_VALUE',
        MediaUrl: 'STRING_VALUE',
        RawContent: 'STRING_VALUE',
        SilentPush: true || false,
        TimeToLive: 'NUMBER_VALUE',
        Title: 'STRING_VALUE',
        Url: 'STRING_VALUE'
      },
      DefaultMessage: {
        Action: OPEN_APP | DEEP_LINK | URL,
        Body: 'STRING_VALUE',
        ImageIconUrl: 'STRING_VALUE',
        ImageSmallIconUrl: 'STRING_VALUE',
        ImageUrl: 'STRING_VALUE',
        JsonBody: 'STRING_VALUE',
        MediaUrl: 'STRING_VALUE',
        RawContent: 'STRING_VALUE',
        SilentPush: true || false,
        TimeToLive: 'NUMBER_VALUE',
        Title: 'STRING_VALUE',
        Url: 'STRING_VALUE'
      },
      EmailMessage: {
        Body: 'STRING_VALUE',
        FromAddress: 'STRING_VALUE',
        HtmlBody: 'STRING_VALUE',
        Title: 'STRING_VALUE'
      },
      GCMMessage: {
        Action: OPEN_APP | DEEP_LINK | URL,
        Body: 'STRING_VALUE',
        ImageIconUrl: 'STRING_VALUE',
        ImageSmallIconUrl: 'STRING_VALUE',
        ImageUrl: 'STRING_VALUE',
        JsonBody: 'STRING_VALUE',
        MediaUrl: 'STRING_VALUE',
        RawContent: 'STRING_VALUE',
        SilentPush: true || false,
        TimeToLive: 'NUMBER_VALUE',
        Title: 'STRING_VALUE',
        Url: 'STRING_VALUE'
      },
      SMSMessage: {
        Body: 'STRING_VALUE',
        MessageType: TRANSACTIONAL | PROMOTIONAL,
        SenderId: 'STRING_VALUE'
      }
    },
    Name: 'STRING_VALUE',
    Schedule: {
      EndTime: 'STRING_VALUE',
      EventFilter: {
        Dimensions: {
          Attributes: {
            '<__string>': {
              AttributeType: INCLUSIVE | EXCLUSIVE,
              Values: [
                'STRING_VALUE',
                /* more items */
              ]
            },
            /* '<__string>': ... */
          },
          EventType: {
            DimensionType: INCLUSIVE | EXCLUSIVE,
            Values: [
              'STRING_VALUE',
              /* more items */
            ]
          },
          Metrics: {
            '<__string>': {
              ComparisonOperator: 'STRING_VALUE',
              Value: 'NUMBER_VALUE'
            },
            /* '<__string>': ... */
          }
        },
        FilterType: SYSTEM | ENDPOINT
      },
      Frequency: ONCE | HOURLY | DAILY | WEEKLY | MONTHLY | EVENT,
      IsLocalTime: true || false,
      QuietTime: {
        End: 'STRING_VALUE',
        Start: 'STRING_VALUE'
      },
      StartTime: 'STRING_VALUE',
      Timezone: 'STRING_VALUE'
    },
    SegmentId: 'STRING_VALUE',
    SegmentVersion: 'NUMBER_VALUE',
    TreatmentDescription: 'STRING_VALUE',
    TreatmentName: 'STRING_VALUE',
    tags: {
      '<__string>': 'STRING_VALUE',
      /* '<__string>': ... */
    }
  }
};
pinpoint.updateCampaign(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.
    • CampaignId — (String) The unique ID of the campaign.
    • WriteCampaignRequest — (map) Used to create a campaign.
      • AdditionalTreatments — (Array<map>) Treatments that are defined in addition to the default treatment.
        • MessageConfiguration — (map) The message configuration settings.
          • ADMMessage — (map) 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. Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • 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 — (map) 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. Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • 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 — (map) 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. Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • 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 — (map) 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. Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • 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 — (map) 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 — (map) 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. Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • 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 — (map) The SMS message configuration.
            • Body — (String) The SMS text body.
            • MessageType — (String) Is this is a transactional SMS message, otherwise a promotional message. Possible values include:
              • "TRANSACTIONAL"
              • "PROMOTIONAL"
            • SenderId — (String) Sender ID of sent message.
        • Schedule — (map) The campaign schedule.
          • EndTime — (String) The scheduled time that the campaign ends in ISO 8601 format.
          • EventFilter — (map) Defines the type of events that can trigger the campaign. Used when the Frequency is set to EVENT.
            • Dimensions — (map) An object that defines the dimensions for the event filter.
              • Attributes — (map<map>) Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
                • 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. Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Values — (Array<String>) 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.
              • EventType — (map) 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. Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Values — (Array<String>) 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.
              • Metrics — (map<map>) Custom metrics that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
                • 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 — (Float) 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. Possible values include:
              • "SYSTEM"
              • "ENDPOINT"
          • Frequency — (String) How often the campaign delivers messages. Valid values: ONCE HOURLY DAILY WEEKLY MONTHLY EVENT Possible values include:
            • "ONCE"
            • "HOURLY"
            • "DAILY"
            • "WEEKLY"
            • "MONTHLY"
            • "EVENT"
          • IsLocalTime — (Boolean) Indicates whether the campaign schedule takes effect according to each user's local time.
          • QuietTime — (map) 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.
        • TreatmentDescription — (String) A custom description for the treatment.
        • TreatmentName — (String) The custom name of a variation of the campaign used for A/B testing.
      • Description — (String) A description of the campaign.
      • HoldoutPercent — (Integer) The allocated percentage of end users who will not receive messages from this campaign.
      • Hook — (map) Campaign hook information.
        • LambdaFunctionName — (String) Lambda function name or arn to be called for delivery
        • Mode — (String) What mode Lambda should be invoked in. Possible values include:
          • "DELIVERY"
          • "FILTER"
        • WebUrl — (String) Web URL to call for hook. If the URL has authentication specified it will be added as authentication to the request
      • IsPaused — (Boolean) Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.
      • Limits — (map) 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 — (map) The message configuration settings.
        • ADMMessage — (map) 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. Possible values include:
            • "OPEN_APP"
            • "DEEP_LINK"
            • "URL"
          • 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 — (map) 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. Possible values include:
            • "OPEN_APP"
            • "DEEP_LINK"
            • "URL"
          • 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 — (map) 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. Possible values include:
            • "OPEN_APP"
            • "DEEP_LINK"
            • "URL"
          • 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 — (map) 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. Possible values include:
            • "OPEN_APP"
            • "DEEP_LINK"
            • "URL"
          • 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 — (map) 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 — (map) 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. Possible values include:
            • "OPEN_APP"
            • "DEEP_LINK"
            • "URL"
          • 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 — (map) The SMS message configuration.
          • Body — (String) The SMS text body.
          • MessageType — (String) Is this is a transactional SMS message, otherwise a promotional message. Possible values include:
            • "TRANSACTIONAL"
            • "PROMOTIONAL"
          • SenderId — (String) Sender ID of sent message.
      • Name — (String) The custom name of the campaign.
      • Schedule — (map) The campaign schedule.
        • EndTime — (String) The scheduled time that the campaign ends in ISO 8601 format.
        • EventFilter — (map) Defines the type of events that can trigger the campaign. Used when the Frequency is set to EVENT.
          • Dimensions — (map) An object that defines the dimensions for the event filter.
            • Attributes — (map<map>) Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
              • 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. Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Values — (Array<String>) 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.
            • EventType — (map) 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. Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Values — (Array<String>) 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.
            • Metrics — (map<map>) Custom metrics that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
              • 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 — (Float) 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. Possible values include:
            • "SYSTEM"
            • "ENDPOINT"
        • Frequency — (String) How often the campaign delivers messages. Valid values: ONCE HOURLY DAILY WEEKLY MONTHLY EVENT Possible values include:
          • "ONCE"
          • "HOURLY"
          • "DAILY"
          • "WEEKLY"
          • "MONTHLY"
          • "EVENT"
        • IsLocalTime — (Boolean) Indicates whether the campaign schedule takes effect according to each user's local time.
        • QuietTime — (map) 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.
      • tags — (map<String>) The Tags for the campaign.
      • TreatmentDescription — (String) A custom description for the treatment.
      • TreatmentName — (String) The custom name of a variation of the campaign used for A/B testing.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CampaignResponse — (map) Campaign definition
        • AdditionalTreatments — (Array<map>) Treatments that are defined in addition to the default treatment.
          • Id — (String) The unique treatment ID.
          • MessageConfiguration — (map) The message configuration settings.
            • ADMMessage — (map) 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. Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • 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 — (map) 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. Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • 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 — (map) 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. Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • 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 — (map) 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. Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • 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 — (map) 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 — (map) 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. Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • 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 — (map) The SMS message configuration.
              • Body — (String) The SMS text body.
              • MessageType — (String) Is this is a transactional SMS message, otherwise a promotional message. Possible values include:
                • "TRANSACTIONAL"
                • "PROMOTIONAL"
              • SenderId — (String) Sender ID of sent message.
          • Schedule — (map) The campaign schedule.
            • EndTime — (String) The scheduled time that the campaign ends in ISO 8601 format.
            • EventFilter — (map) Defines the type of events that can trigger the campaign. Used when the Frequency is set to EVENT.
              • Dimensions — (map) An object that defines the dimensions for the event filter.
                • Attributes — (map<map>) Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
                  • 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
                • EventType — (map) 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
                • Metrics — (map<map>) Custom metrics that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
                  • 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 — (Float) 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. Possible values include:
                • "SYSTEM"
                • "ENDPOINT"
            • Frequency — (String) How often the campaign delivers messages. Valid values: ONCE HOURLY DAILY WEEKLY MONTHLY EVENT Possible values include:
              • "ONCE"
              • "HOURLY"
              • "DAILY"
              • "WEEKLY"
              • "MONTHLY"
              • "EVENT"
            • IsLocalTime — (Boolean) Indicates whether the campaign schedule takes effect according to each user's local time.
            • QuietTime — (map) 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 — (map) 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 Possible values include:
              • "SCHEDULED"
              • "EXECUTING"
              • "PENDING_NEXT_RUN"
              • "COMPLETED"
              • "PAUSED"
              • "DELETED"
          • 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.
        • Arn — (String) The arn for the campaign.
        • CreationDate — (String) The date the campaign was created in ISO 8601 format.
        • DefaultState — (map) 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 Possible values include:
            • "SCHEDULED"
            • "EXECUTING"
            • "PENDING_NEXT_RUN"
            • "COMPLETED"
            • "PAUSED"
            • "DELETED"
        • Description — (String) A description of the campaign.
        • HoldoutPercent — (Integer) The allocated percentage of end users who will not receive messages from this campaign.
        • Hook — (map) Campaign hook information.
          • LambdaFunctionName — (String) Lambda function name or arn to be called for delivery
          • Mode — (String) What mode Lambda should be invoked in. Possible values include:
            • "DELIVERY"
            • "FILTER"
          • 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 — (map) 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 — (map) The message configuration settings.
          • ADMMessage — (map) 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. Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • 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 — (map) 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. Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • 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 — (map) 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. Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • 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 — (map) 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. Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • 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 — (map) 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 — (map) 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. Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • 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 — (map) The SMS message configuration.
            • Body — (String) The SMS text body.
            • MessageType — (String) Is this is a transactional SMS message, otherwise a promotional message. Possible values include:
              • "TRANSACTIONAL"
              • "PROMOTIONAL"
            • SenderId — (String) Sender ID of sent message.
        • Name — (String) The custom name of the campaign.
        • Schedule — (map) The campaign schedule.
          • EndTime — (String) The scheduled time that the campaign ends in ISO 8601 format.
          • EventFilter — (map) Defines the type of events that can trigger the campaign. Used when the Frequency is set to EVENT.
            • Dimensions — (map) An object that defines the dimensions for the event filter.
              • Attributes — (map<map>) Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
                • 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. Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Values — (Array<String>) 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.
              • EventType — (map) 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. Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Values — (Array<String>) 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.
              • Metrics — (map<map>) Custom metrics that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
                • 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 — (Float) 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. Possible values include:
              • "SYSTEM"
              • "ENDPOINT"
          • Frequency — (String) How often the campaign delivers messages. Valid values: ONCE HOURLY DAILY WEEKLY MONTHLY EVENT Possible values include:
            • "ONCE"
            • "HOURLY"
            • "DAILY"
            • "WEEKLY"
            • "MONTHLY"
            • "EVENT"
          • IsLocalTime — (Boolean) Indicates whether the campaign schedule takes effect according to each user's local time.
          • QuietTime — (map) 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 — (map) 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 Possible values include:
            • "SCHEDULED"
            • "EXECUTING"
            • "PENDING_NEXT_RUN"
            • "COMPLETED"
            • "PAUSED"
            • "DELETED"
        • tags — (map<String>) The Tags for the campaign.
        • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateEmailChannel(params = {}, callback) ⇒ AWS.Request

Update an email channel.

Service Reference:

Examples:

Calling the updateEmailChannel operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  EmailChannelRequest: { /* required */
    ConfigurationSet: 'STRING_VALUE',
    Enabled: true || false,
    FromAddress: 'STRING_VALUE',
    Identity: 'STRING_VALUE',
    RoleArn: 'STRING_VALUE'
  }
};
pinpoint.updateEmailChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.
    • EmailChannelRequest — (map) Email Channel Request
      • ConfigurationSet — (String) The configuration set that you want to use when you send email using the Pinpoint Email API.
      • Enabled — (Boolean) If the channel is enabled for sending messages.
      • FromAddress — (String) The email address used to send emails from.
      • Identity — (String) The ARN of an identity verified with SES.
      • RoleArn — (String) The ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion service

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • EmailChannelResponse — (map) Email Channel Response.
        • ApplicationId — (String) The unique ID of the application to which the email channel belongs.
        • ConfigurationSet — (String) The configuration set that you want to use when you send email using the Pinpoint Email API.
        • CreationDate — (String) The date that the settings were last updated in ISO 8601 format.
        • Enabled — (Boolean) If the channel is enabled for sending messages.
        • FromAddress — (String) The email address used to send emails from.
        • HasCredential — (Boolean) Not used. Retained for backwards compatibility.
        • Id — (String) Channel ID. Not used, only for backwards compatibility.
        • Identity — (String) The ARN of an identity verified with SES.
        • IsArchived — (Boolean) Is this channel archived
        • LastModifiedBy — (String) Who last updated this entry
        • LastModifiedDate — (String) Last date this was updated
        • MessagesPerSecond — (Integer) Messages per second that can be sent
        • Platform — (String) Platform type. Will be "EMAIL"
        • RoleArn — (String) The ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion service
        • Version — (Integer) Version of channel

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateEndpoint(params = {}, callback) ⇒ AWS.Request

Creates or updates an endpoint.

Service Reference:

Examples:

Calling the updateEndpoint operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  EndpointId: 'STRING_VALUE', /* required */
  EndpointRequest: { /* required */
    Address: 'STRING_VALUE',
    Attributes: {
      '<__string>': [
        'STRING_VALUE',
        /* more items */
      ],
      /* '<__string>': ... */
    },
    ChannelType: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | VOICE | EMAIL | BAIDU | CUSTOM,
    Demographic: {
      AppVersion: 'STRING_VALUE',
      Locale: 'STRING_VALUE',
      Make: 'STRING_VALUE',
      Model: 'STRING_VALUE',
      ModelVersion: 'STRING_VALUE',
      Platform: 'STRING_VALUE',
      PlatformVersion: 'STRING_VALUE',
      Timezone: 'STRING_VALUE'
    },
    EffectiveDate: 'STRING_VALUE',
    EndpointStatus: 'STRING_VALUE',
    Location: {
      City: 'STRING_VALUE',
      Country: 'STRING_VALUE',
      Latitude: 'NUMBER_VALUE',
      Longitude: 'NUMBER_VALUE',
      PostalCode: 'STRING_VALUE',
      Region: 'STRING_VALUE'
    },
    Metrics: {
      '<__string>': 'NUMBER_VALUE',
      /* '<__string>': ... */
    },
    OptOut: 'STRING_VALUE',
    RequestId: 'STRING_VALUE',
    User: {
      UserAttributes: {
        '<__string>': [
          'STRING_VALUE',
          /* more items */
        ],
        /* '<__string>': ... */
      },
      UserId: 'STRING_VALUE'
    }
  }
};
pinpoint.updateEndpoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.
    • EndpointId — (String) The unique ID of the endpoint.
    • EndpointRequest — (map) An endpoint update request.
      • Address — (String) The destination for messages that you send to this endpoint. The address varies by channel. For mobile push channels, use the token provided by the push notification service, such as the APNs device token or the FCM registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.
      • Attributes — (map<Array<String>>) Custom attributes that describe the endpoint by associating a name with an array of values. For example, an attribute named "interests" might have the values ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create a segment of users to engage with a messaging campaign. The following characters are not recommended in attribute names: # : ? \ /. The Amazon Pinpoint console does not display attributes that include these characters in the name. This limitation does not apply to attribute values.
      • ChannelType — (String) The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU Possible values include:
        • "GCM"
        • "APNS"
        • "APNS_SANDBOX"
        • "APNS_VOIP"
        • "APNS_VOIP_SANDBOX"
        • "ADM"
        • "SMS"
        • "VOICE"
        • "EMAIL"
        • "BAIDU"
        • "CUSTOM"
      • Demographic — (map) Demographic attributes for the endpoint.
        • AppVersion — (String) The version of the application associated with the endpoint.
        • Locale — (String) The endpoint locale in the following format: The ISO 639-1 alpha-2 code, followed by an underscore, followed by an ISO 3166-1 alpha-2 value.
        • Make — (String) The manufacturer of the endpoint device, such as Apple or Samsung.
        • Model — (String) The model name or number of the endpoint device, such as iPhone.
        • ModelVersion — (String) The model version of the endpoint device.
        • Platform — (String) The platform of the endpoint device, such as iOS or Android.
        • PlatformVersion — (String) The platform version of the endpoint device.
        • Timezone — (String) The timezone of the endpoint. Specified as a tz database value, such as Americas/Los_Angeles.
      • EffectiveDate — (String) The date and time when the endpoint was updated, shown in ISO 8601 format.
      • EndpointStatus — (String) Unused.
      • Location — (map) The endpoint location attributes.
        • City — (String) The city where the endpoint is located.
        • Country — (String) The two-letter code for the country or region of the endpoint. Specified as an ISO 3166-1 alpha-2 code, such as "US" for the United States.
        • Latitude — (Float) The latitude of the endpoint location, rounded to one decimal place.
        • Longitude — (Float) The longitude of the endpoint location, rounded to one decimal place.
        • PostalCode — (String) The postal code or zip code of the endpoint.
        • Region — (String) The region of the endpoint location. For example, in the United States, this corresponds to a state.
      • Metrics — (map<Float>) Custom metrics that your app reports to Amazon Pinpoint.
      • OptOut — (String) Indicates whether a user has opted out of receiving messages with one of the following values: ALL - User has opted out of all messages. NONE - Users has not opted out and receives all messages.
      • RequestId — (String) The unique ID for the most recent request to update the endpoint.
      • User — (map) Custom user-specific attributes that your app reports to Amazon Pinpoint.
        • UserAttributes — (map<Array<String>>) Custom attributes that describe the user by associating a name with an array of values. For example, an attribute named "interests" might have the following values: ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create segments. The Amazon Pinpoint console can't display attribute names that include the following characters: hash/pound sign (#), colon (:), question mark (?), backslash (), and forward slash (/). For this reason, you should avoid using these characters in the names of custom attributes.
        • UserId — (String) The unique ID of the user.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • MessageBody — (map) Simple message object.
        • Message — (String) The error message that's returned from the API.
        • RequestID — (String) The unique message body ID.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateEndpointsBatch(params = {}, callback) ⇒ AWS.Request

Use to update a batch of endpoints.

Service Reference:

Examples:

Calling the updateEndpointsBatch operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  EndpointBatchRequest: { /* required */
    Item: [
      {
        Address: 'STRING_VALUE',
        Attributes: {
          '<__string>': [
            'STRING_VALUE',
            /* more items */
          ],
          /* '<__string>': ... */
        },
        ChannelType: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | VOICE | EMAIL | BAIDU | CUSTOM,
        Demographic: {
          AppVersion: 'STRING_VALUE',
          Locale: 'STRING_VALUE',
          Make: 'STRING_VALUE',
          Model: 'STRING_VALUE',
          ModelVersion: 'STRING_VALUE',
          Platform: 'STRING_VALUE',
          PlatformVersion: 'STRING_VALUE',
          Timezone: 'STRING_VALUE'
        },
        EffectiveDate: 'STRING_VALUE',
        EndpointStatus: 'STRING_VALUE',
        Id: 'STRING_VALUE',
        Location: {
          City: 'STRING_VALUE',
          Country: 'STRING_VALUE',
          Latitude: 'NUMBER_VALUE',
          Longitude: 'NUMBER_VALUE',
          PostalCode: 'STRING_VALUE',
          Region: 'STRING_VALUE'
        },
        Metrics: {
          '<__string>': 'NUMBER_VALUE',
          /* '<__string>': ... */
        },
        OptOut: 'STRING_VALUE',
        RequestId: 'STRING_VALUE',
        User: {
          UserAttributes: {
            '<__string>': [
              'STRING_VALUE',
              /* more items */
            ],
            /* '<__string>': ... */
          },
          UserId: 'STRING_VALUE'
        }
      },
      /* more items */
    ]
  }
};
pinpoint.updateEndpointsBatch(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.
    • EndpointBatchRequest — (map) Endpoint batch update request.
      • Item — (Array<map>) List of items to update. Maximum 100 items
        • Address — (String) The destination for messages that you send to this endpoint. The address varies by channel. For mobile push channels, use the token provided by the push notification service, such as the APNs device token or the FCM registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.
        • Attributes — (map<Array<String>>) Custom attributes that describe the endpoint by associating a name with an array of values. For example, an attribute named "interests" might have the values ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create a segment of users to engage with a messaging campaign. The following characters are not recommended in attribute names: # : ? \ /. The Amazon Pinpoint console does not display attributes that include these characters in the name. This limitation does not apply to attribute values.
        • ChannelType — (String) The channel type. Valid values: GCM | APNS | APNS_SANDBOX | APNS_VOIP | APNS_VOIP_SANDBOX | ADM | SMS | EMAIL | BAIDU Possible values include:
          • "GCM"
          • "APNS"
          • "APNS_SANDBOX"
          • "APNS_VOIP"
          • "APNS_VOIP_SANDBOX"
          • "ADM"
          • "SMS"
          • "VOICE"
          • "EMAIL"
          • "BAIDU"
          • "CUSTOM"
        • Demographic — (map) The endpoint demographic attributes.
          • AppVersion — (String) The version of the application associated with the endpoint.
          • Locale — (String) The endpoint locale in the following format: The ISO 639-1 alpha-2 code, followed by an underscore, followed by an ISO 3166-1 alpha-2 value.
          • Make — (String) The manufacturer of the endpoint device, such as Apple or Samsung.
          • Model — (String) The model name or number of the endpoint device, such as iPhone.
          • ModelVersion — (String) The model version of the endpoint device.
          • Platform — (String) The platform of the endpoint device, such as iOS or Android.
          • PlatformVersion — (String) The platform version of the endpoint device.
          • Timezone — (String) The timezone of the endpoint. Specified as a tz database value, such as Americas/Los_Angeles.
        • EffectiveDate — (String) The last time the endpoint was updated. Provided in ISO 8601 format.
        • EndpointStatus — (String) Unused.
        • Id — (String) The unique Id for the Endpoint in the batch.
        • Location — (map) The endpoint location attributes.
          • City — (String) The city where the endpoint is located.
          • Country — (String) The two-letter code for the country or region of the endpoint. Specified as an ISO 3166-1 alpha-2 code, such as "US" for the United States.
          • Latitude — (Float) The latitude of the endpoint location, rounded to one decimal place.
          • Longitude — (Float) The longitude of the endpoint location, rounded to one decimal place.
          • PostalCode — (String) The postal code or zip code of the endpoint.
          • Region — (String) The region of the endpoint location. For example, in the United States, this corresponds to a state.
        • Metrics — (map<Float>) Custom metrics that your app reports to Amazon Pinpoint.
        • OptOut — (String) Indicates whether a user has opted out of receiving messages with one of the following values: ALL - User has opted out of all messages. NONE - Users has not opted out and receives all messages.
        • RequestId — (String) The unique ID for the most recent request to update the endpoint.
        • User — (map) Custom user-specific attributes that your app reports to Amazon Pinpoint.
          • UserAttributes — (map<Array<String>>) Custom attributes that describe the user by associating a name with an array of values. For example, an attribute named "interests" might have the following values: ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create segments. The Amazon Pinpoint console can't display attribute names that include the following characters: hash/pound sign (#), colon (:), question mark (?), backslash (), and forward slash (/). For this reason, you should avoid using these characters in the names of custom attributes.
          • UserId — (String) The unique ID of the user.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • MessageBody — (map) Simple message object.
        • Message — (String) The error message that's returned from the API.
        • RequestID — (String) The unique message body ID.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateGcmChannel(params = {}, callback) ⇒ AWS.Request

Use to update the GCM channel for an app.

Service Reference:

Examples:

Calling the updateGcmChannel operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  GCMChannelRequest: { /* required */
    ApiKey: 'STRING_VALUE',
    Enabled: true || false
  }
};
pinpoint.updateGcmChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.
    • GCMChannelRequest — (map) Google Cloud Messaging credentials
      • ApiKey — (String) Platform credential API key from Google.
      • Enabled — (Boolean) If the channel is enabled for sending messages.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GCMChannelResponse — (map) Google Cloud Messaging channel definition
        • ApplicationId — (String) The ID of the application to which the channel applies.
        • CreationDate — (String) When was this segment created
        • Credential — (String) The GCM API key from Google.
        • Enabled — (Boolean) If the channel is enabled for sending messages.
        • HasCredential — (Boolean) Not used. Retained for backwards compatibility.
        • Id — (String) Channel ID. Not used. Present only for backwards compatibility.
        • IsArchived — (Boolean) Is this channel archived
        • LastModifiedBy — (String) Who last updated this entry
        • LastModifiedDate — (String) Last date this was updated
        • Platform — (String) The platform type. Will be GCM
        • Version — (Integer) Version of channel

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateSegment(params = {}, callback) ⇒ AWS.Request

Used to update a segment.

Service Reference:

Examples:

Calling the updateSegment operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  SegmentId: 'STRING_VALUE', /* required */
  WriteSegmentRequest: { /* required */
    Dimensions: {
      Attributes: {
        '<__string>': {
          AttributeType: INCLUSIVE | EXCLUSIVE,
          Values: [
            'STRING_VALUE',
            /* more items */
          ]
        },
        /* '<__string>': ... */
      },
      Behavior: {
        Recency: {
          Duration: HR_24 | DAY_7 | DAY_14 | DAY_30,
          RecencyType: ACTIVE | INACTIVE
        }
      },
      Demographic: {
        AppVersion: {
          DimensionType: INCLUSIVE | EXCLUSIVE,
          Values: [
            'STRING_VALUE',
            /* more items */
          ]
        },
        Channel: {
          DimensionType: INCLUSIVE | EXCLUSIVE,
          Values: [
            'STRING_VALUE',
            /* more items */
          ]
        },
        DeviceType: {
          DimensionType: INCLUSIVE | EXCLUSIVE,
          Values: [
            'STRING_VALUE',
            /* more items */
          ]
        },
        Make: {
          DimensionType: INCLUSIVE | EXCLUSIVE,
          Values: [
            'STRING_VALUE',
            /* more items */
          ]
        },
        Model: {
          DimensionType: INCLUSIVE | EXCLUSIVE,
          Values: [
            'STRING_VALUE',
            /* more items */
          ]
        },
        Platform: {
          DimensionType: INCLUSIVE | EXCLUSIVE,
          Values: [
            'STRING_VALUE',
            /* more items */
          ]
        }
      },
      Location: {
        Country: {
          DimensionType: INCLUSIVE | EXCLUSIVE,
          Values: [
            'STRING_VALUE',
            /* more items */
          ]
        },
        GPSPoint: {
          Coordinates: {
            Latitude: 'NUMBER_VALUE',
            Longitude: 'NUMBER_VALUE'
          },
          RangeInKilometers: 'NUMBER_VALUE'
        }
      },
      Metrics: {
        '<__string>': {
          ComparisonOperator: 'STRING_VALUE',
          Value: 'NUMBER_VALUE'
        },
        /* '<__string>': ... */
      },
      UserAttributes: {
        '<__string>': {
          AttributeType: INCLUSIVE | EXCLUSIVE,
          Values: [
            'STRING_VALUE',
            /* more items */
          ]
        },
        /* '<__string>': ... */
      }
    },
    Name: 'STRING_VALUE',
    SegmentGroups: {
      Groups: [
        {
          Dimensions: [
            {
              Attributes: {
                '<__string>': {
                  AttributeType: INCLUSIVE | EXCLUSIVE,
                  Values: [
                    'STRING_VALUE',
                    /* more items */
                  ]
                },
                /* '<__string>': ... */
              },
              Behavior: {
                Recency: {
                  Duration: HR_24 | DAY_7 | DAY_14 | DAY_30,
                  RecencyType: ACTIVE | INACTIVE
                }
              },
              Demographic: {
                AppVersion: {
                  DimensionType: INCLUSIVE | EXCLUSIVE,
                  Values: [
                    'STRING_VALUE',
                    /* more items */
                  ]
                },
                Channel: {
                  DimensionType: INCLUSIVE | EXCLUSIVE,
                  Values: [
                    'STRING_VALUE',
                    /* more items */
                  ]
                },
                DeviceType: {
                  DimensionType: INCLUSIVE | EXCLUSIVE,
                  Values: [
                    'STRING_VALUE',
                    /* more items */
                  ]
                },
                Make: {
                  DimensionType: INCLUSIVE | EXCLUSIVE,
                  Values: [
                    'STRING_VALUE',
                    /* more items */
                  ]
                },
                Model: {
                  DimensionType: INCLUSIVE | EXCLUSIVE,
                  Values: [
                    'STRING_VALUE',
                    /* more items */
                  ]
                },
                Platform: {
                  DimensionType: INCLUSIVE | EXCLUSIVE,
                  Values: [
                    'STRING_VALUE',
                    /* more items */
                  ]
                }
              },
              Location: {
                Country: {
                  DimensionType: INCLUSIVE | EXCLUSIVE,
                  Values: [
                    'STRING_VALUE',
                    /* more items */
                  ]
                },
                GPSPoint: {
                  Coordinates: {
                    Latitude: 'NUMBER_VALUE',
                    Longitude: 'NUMBER_VALUE'
                  },
                  RangeInKilometers: 'NUMBER_VALUE'
                }
              },
              Metrics: {
                '<__string>': {
                  ComparisonOperator: 'STRING_VALUE',
                  Value: 'NUMBER_VALUE'
                },
                /* '<__string>': ... */
              },
              UserAttributes: {
                '<__string>': {
                  AttributeType: INCLUSIVE | EXCLUSIVE,
                  Values: [
                    'STRING_VALUE',
                    /* more items */
                  ]
                },
                /* '<__string>': ... */
              }
            },
            /* more items */
          ],
          SourceSegments: [
            {
              Id: 'STRING_VALUE',
              Version: 'NUMBER_VALUE'
            },
            /* more items */
          ],
          SourceType: ALL | ANY | NONE,
          Type: ALL | ANY | NONE
        },
        /* more items */
      ],
      Include: ALL | ANY | NONE
    },
    tags: {
      '<__string>': 'STRING_VALUE',
      /* '<__string>': ... */
    }
  }
};
pinpoint.updateSegment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.
    • SegmentId — (String) The unique ID of the segment.
    • WriteSegmentRequest — (map) Segment definition.
      • Dimensions — (map) The segment dimensions attributes.
        • Attributes — (map<map>) Custom segment attributes.
          • 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. Possible values include:
            • "INCLUSIVE"
            • "EXCLUSIVE"
          • Values — (Array<String>) 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.
        • Behavior — (map) The segment behaviors attributes.
          • Recency — (map) The recency of use.
            • Duration — (String) The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30 Possible values include:
              • "HR_24"
              • "DAY_7"
              • "DAY_14"
              • "DAY_30"
            • RecencyType — (String) The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment. Possible values include:
              • "ACTIVE"
              • "INACTIVE"
        • Demographic — (map) The segment demographics attributes.
          • AppVersion — (map) The app version criteria for the segment.
            • 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. Possible values include:
              • "INCLUSIVE"
              • "EXCLUSIVE"
            • Values — (Array<String>) 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.
          • Channel — (map) The channel criteria for the segment.
            • 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. Possible values include:
              • "INCLUSIVE"
              • "EXCLUSIVE"
            • Values — (Array<String>) 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.
          • DeviceType — (map) The device type criteria for the segment.
            • 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. Possible values include:
              • "INCLUSIVE"
              • "EXCLUSIVE"
            • Values — (Array<String>) 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.
          • Make — (map) The device make criteria for the segment.
            • 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. Possible values include:
              • "INCLUSIVE"
              • "EXCLUSIVE"
            • Values — (Array<String>) 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.
          • Model — (map) The device model criteria for the segment.
            • 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. Possible values include:
              • "INCLUSIVE"
              • "EXCLUSIVE"
            • Values — (Array<String>) 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.
          • Platform — (map) The device platform criteria for the segment.
            • 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. Possible values include:
              • "INCLUSIVE"
              • "EXCLUSIVE"
            • Values — (Array<String>) 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.
        • Location — (map) The segment location attributes.
          • Country — (map) The country or region, in ISO 3166-1 alpha-2 format.
            • 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. Possible values include:
              • "INCLUSIVE"
              • "EXCLUSIVE"
            • Values — (Array<String>) 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.
          • GPSPoint — (map) The GPS Point dimension.
            • Coordinates — (map) Coordinate to measure distance from.
              • Latitude — (Float) Latitude
              • Longitude — (Float) Longitude
            • RangeInKilometers — (Float) Range in kilometers from the coordinate.
        • Metrics — (map<map>) Custom segment metrics.
          • 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 — (Float) The value to be compared.
        • UserAttributes — (map<map>) Custom segment user attributes.
          • 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. Possible values include:
            • "INCLUSIVE"
            • "EXCLUSIVE"
          • Values — (Array<String>) 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.
      • Name — (String) The name of segment
      • SegmentGroups — (map) A segment group, which consists of zero or more source segments, plus dimensions that are applied to those source segments. Your request can only include one segment group. Your request can include either a SegmentGroups object or a Dimensions object, but not both.
        • Groups — (Array<map>) A set of segment criteria to evaluate.
          • Dimensions — (Array<map>) List of dimensions to include or exclude.
            • Attributes — (map<map>) Custom segment attributes.
              • 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. Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Values — (Array<String>) 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.
            • Behavior — (map) The segment behaviors attributes.
              • Recency — (map) The recency of use.
                • Duration — (String) The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30 Possible values include:
                  • "HR_24"
                  • "DAY_7"
                  • "DAY_14"
                  • "DAY_30"
                • RecencyType — (String) The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment. Possible values include:
                  • "ACTIVE"
                  • "INACTIVE"
            • Demographic — (map) The segment demographics attributes.
              • AppVersion — (map) The app version criteria for the segment.
                • 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. Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Values — (Array<String>) 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.
              • Channel — (map) The channel criteria for the segment.
                • 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. Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Values — (Array<String>) 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.
              • DeviceType — (map) The device type criteria for the segment.
                • 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. Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Values — (Array<String>) 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.
              • Make — (map) The device make criteria for the segment.
                • 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. Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Values — (Array<String>) 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.
              • Model — (map) The device model criteria for the segment.
                • 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. Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Values — (Array<String>) 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.
              • Platform — (map) The device platform criteria for the segment.
                • 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. Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Values — (Array<String>) 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.
            • Location — (map) The segment location attributes.
              • Country — (map) The country or region, in ISO 3166-1 alpha-2 format.
                • 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. Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Values — (Array<String>) 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.
              • GPSPoint — (map) The GPS Point dimension.
                • Coordinates — (map) Coordinate to measure distance from.
                  • Latitude — (Float) Latitude
                  • Longitude — (Float) Longitude
                • RangeInKilometers — (Float) Range in kilometers from the coordinate.
            • Metrics — (map<map>) Custom segment metrics.
              • 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 — (Float) The value to be compared.
            • UserAttributes — (map<map>) Custom segment user attributes.
              • 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. Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Values — (Array<String>) 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.
          • SourceSegments — (Array<map>) The base segment that you build your segment on. The source segment defines the starting "universe" of endpoints. When you add dimensions to the segment, it filters the source segment based on the dimensions that you specify. You can specify more than one dimensional segment. You can only specify one imported segment. NOTE: If you specify an imported segment for this attribute, the segment size estimate that appears in the Amazon Pinpoint console shows the size of the imported segment, without any filters applied to it.
            • Id — (String) A unique identifier for the segment.
            • Version — (Integer) If specified contains a specific version of the segment included.
          • SourceType — (String) Specify how to handle multiple source segments. For example, if you specify three source segments, should the resulting segment be based on any or all of the segments? Acceptable values: ANY or ALL. Possible values include:
            • "ALL"
            • "ANY"
            • "NONE"
          • Type — (String) Specify how to handle multiple segment dimensions. For example, if you specify three dimensions, should the resulting segment include endpoints that are matched by all, any, or none of the dimensions? Acceptable values: ALL, ANY, or NONE. Possible values include:
            • "ALL"
            • "ANY"
            • "NONE"
        • Include — (String) Specify how to handle multiple segment groups. For example, if the segment includes three segment groups, should the resulting segment include endpoints that are matched by all, any, or none of the segment groups you created. Acceptable values: ALL, ANY, or NONE. Possible values include:
          • "ALL"
          • "ANY"
          • "NONE"
      • tags — (map<String>) The Tags for the segments.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SegmentResponse — (map) Segment definition.
        • ApplicationId — (String) The ID of the application that the segment applies to.
        • Arn — (String) The arn for the segment.
        • CreationDate — (String) The date and time when the segment was created.
        • Dimensions — (map) The segment dimensions attributes.
          • Attributes — (map<map>) Custom segment attributes.
            • 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. Possible values include:
              • "INCLUSIVE"
              • "EXCLUSIVE"
            • Values — (Array<String>) 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.
          • Behavior — (map) The segment behaviors attributes.
            • Recency — (map) The recency of use.
              • Duration — (String) The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30 Possible values include:
                • "HR_24"
                • "DAY_7"
                • "DAY_14"
                • "DAY_30"
              • RecencyType — (String) The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment. Possible values include:
                • "ACTIVE"
                • "INACTIVE"
          • Demographic — (map) The segment demographics attributes.
            • AppVersion — (map) The app version criteria for the segment.
              • 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. Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Values — (Array<String>) 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.
            • Channel — (map) The channel criteria for the segment.
              • 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. Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Values — (Array<String>) 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.
            • DeviceType — (map) The device type criteria for the segment.
              • 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. Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Values — (Array<String>) 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.
            • Make — (map) The device make criteria for the segment.
              • 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. Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Values — (Array<String>) 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.
            • Model — (map) The device model criteria for the segment.
              • 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. Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Values — (Array<String>) 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.
            • Platform — (map) The device platform criteria for the segment.
              • 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. Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Values — (Array<String>) 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.
          • Location — (map) The segment location attributes.
            • Country — (map) The country or region, in ISO 3166-1 alpha-2 format.
              • 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. Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Values — (Array<String>) 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.
            • GPSPoint — (map) The GPS Point dimension.
              • Coordinates — (map) Coordinate to measure distance from.
                • Latitude — (Float) Latitude
                • Longitude — (Float) Longitude
              • RangeInKilometers — (Float) Range in kilometers from the coordinate.
          • Metrics — (map<map>) Custom segment metrics.
            • 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 — (Float) The value to be compared.
          • UserAttributes — (map<map>) Custom segment user attributes.
            • 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. Possible values include:
              • "INCLUSIVE"
              • "EXCLUSIVE"
            • Values — (Array<String>) 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.
        • Id — (String) The unique segment ID.
        • ImportDefinition — (map) The import job settings.
          • ChannelCounts — (map<Integer>) The number of channel types in the imported segment.
          • ExternalId — (String) (Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.
          • Format — (String) The format of the endpoint files that were imported to create this segment. Valid values: CSV, JSON Possible values include:
            • "CSV"
            • "JSON"
          • RoleArn — (String) The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the endpoints in Amazon S3.
          • S3Url — (String) The URL of the S3 bucket that the segment was imported from.
          • Size — (Integer) The number of endpoints that were successfully imported to create this segment.
        • LastModifiedDate — (String) The date and time when the segment was last modified.
        • Name — (String) The name of the segment.
        • SegmentGroups — (map) A segment group, which consists of zero or more source segments, plus dimensions that are applied to those source segments.
          • Groups — (Array<map>) A set of segment criteria to evaluate.
            • Dimensions — (Array<map>) List of dimensions to include or exclude.
              • Attributes — (map<map>) Custom segment attributes.
                • 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. Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Values — (Array<String>) 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.
              • Behavior — (map) The segment behaviors attributes.
                • Recency — (map) The recency of use.
                  • Duration — (String) The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30 Possible values include:
                    • "HR_24"
                    • "DAY_7"
                    • "DAY_14"
                    • "DAY_30"
                  • RecencyType — (String) The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment. Possible values include:
                    • "ACTIVE"
                    • "INACTIVE"
              • Demographic — (map) The segment demographics attributes.
                • AppVersion — (map) The app version criteria for the segment.
                  • 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
                • Channel — (map) The channel criteria for the segment.
                  • 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
                • DeviceType — (map) The device type criteria for the segment.
                  • 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
                • Make — (map) The device make criteria for the segment.
                  • 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
                • Model — (map) The device model criteria for the segment.
                  • 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
                • Platform — (map) The device platform criteria for the segment.
                  • 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
              • Location — (map) The segment location attributes.
                • Country — (map) The country or region, in ISO 3166-1 alpha-2 format.
                  • 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. Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Values — (Array<String>) 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.
                • GPSPoint — (map) The GPS Point dimension.
                  • Coordinates — (map) Coordinate to measure distance from.
                    • Latitude — (Float) Latitude
                    • Longitude — (Float) Longitude
                  • RangeInKilometers — (Float) Range in kilometers from the coordinate.
              • Metrics — (map<map>) Custom segment metrics.
                • 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 — (Float) The value to be compared.
              • UserAttributes — (map<map>) Custom segment user attributes.
                • 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. Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Values — (Array<String>) 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.
            • SourceSegments — (Array<map>) The base segment that you build your segment on. The source segment defines the starting "universe" of endpoints. When you add dimensions to the segment, it filters the source segment based on the dimensions that you specify. You can specify more than one dimensional segment. You can only specify one imported segment. NOTE: If you specify an imported segment for this attribute, the segment size estimate that appears in the Amazon Pinpoint console shows the size of the imported segment, without any filters applied to it.
              • Id — (String) A unique identifier for the segment.
              • Version — (Integer) If specified contains a specific version of the segment included.
            • SourceType — (String) Specify how to handle multiple source segments. For example, if you specify three source segments, should the resulting segment be based on any or all of the segments? Acceptable values: ANY or ALL. Possible values include:
              • "ALL"
              • "ANY"
              • "NONE"
            • Type — (String) Specify how to handle multiple segment dimensions. For example, if you specify three dimensions, should the resulting segment include endpoints that are matched by all, any, or none of the dimensions? Acceptable values: ALL, ANY, or NONE. Possible values include:
              • "ALL"
              • "ANY"
              • "NONE"
          • Include — (String) Specify how to handle multiple segment groups. For example, if the segment includes three segment groups, should the resulting segment include endpoints that are matched by all, any, or none of the segment groups you created. Acceptable values: ALL, ANY, or NONE. Possible values include:
            • "ALL"
            • "ANY"
            • "NONE"
        • SegmentType — (String) The segment type: DIMENSIONAL - A dynamic segment built from selection criteria based on endpoint data reported by your app. You create this type of segment by using the segment builder in the Amazon Pinpoint console or by making a POST request to the segments resource. IMPORT - A static segment built from an imported set of endpoint definitions. You create this type of segment by importing a segment in the Amazon Pinpoint console or by making a POST request to the jobs/import resource. Possible values include:
          • "DIMENSIONAL"
          • "IMPORT"
        • tags — (map<String>) The Tags for the segment.
        • Version — (Integer) The segment version number.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateSmsChannel(params = {}, callback) ⇒ AWS.Request

Update an SMS channel.

Service Reference:

Examples:

Calling the updateSmsChannel operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  SMSChannelRequest: { /* required */
    Enabled: true || false,
    SenderId: 'STRING_VALUE',
    ShortCode: 'STRING_VALUE'
  }
};
pinpoint.updateSmsChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.
    • SMSChannelRequest — (map) SMS Channel Request
      • Enabled — (Boolean) If the channel is enabled for sending messages.
      • SenderId — (String) Sender identifier of your messages.
      • ShortCode — (String) ShortCode registered with phone provider.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SMSChannelResponse — (map) SMS Channel Response.
        • ApplicationId — (String) The unique ID of the application to which the SMS channel belongs.
        • CreationDate — (String) The date that the settings were last updated in ISO 8601 format.
        • Enabled — (Boolean) If the channel is enabled for sending messages.
        • HasCredential — (Boolean) Not used. Retained for backwards compatibility.
        • Id — (String) Channel ID. Not used, only for backwards compatibility.
        • IsArchived — (Boolean) Is this channel archived
        • LastModifiedBy — (String) Who last updated this entry
        • LastModifiedDate — (String) Last date this was updated
        • Platform — (String) Platform type. Will be "SMS"
        • PromotionalMessagesPerSecond — (Integer) Promotional messages per second that can be sent
        • SenderId — (String) Sender identifier of your messages.
        • ShortCode — (String) The short code registered with the phone provider.
        • TransactionalMessagesPerSecond — (Integer) Transactional messages per second that can be sent
        • Version — (Integer) Version of channel

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateVoiceChannel(params = {}, callback) ⇒ AWS.Request

Update an Voice channel

Service Reference:

Examples:

Calling the updateVoiceChannel operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  VoiceChannelRequest: { /* required */
    Enabled: true || false
  }
};
pinpoint.updateVoiceChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String) The unique ID of your Amazon Pinpoint application.
    • VoiceChannelRequest — (map) Voice Channel Request
      • Enabled — (Boolean) If the channel is enabled for sending messages.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • VoiceChannelResponse — (map) Voice Channel Response.
        • ApplicationId — (String) Application id
        • CreationDate — (String) The date that the settings were last updated in ISO 8601 format.
        • Enabled — (Boolean) If the channel is enabled for sending messages.
        • HasCredential — (Boolean)
        • Id — (String) Channel ID. Not used, only for backwards compatibility.
        • IsArchived — (Boolean) Is this channel archived
        • LastModifiedBy — (String) Who made the last change
        • LastModifiedDate — (String) Last date this was updated
        • Platform — (String) Platform type. Will be "Voice"
        • Version — (Integer) Version of channel

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.