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

Doc Engage API - Amazon Pinpoint API

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 collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

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 error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. 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.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpointAWS.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 an application.

Service Reference:

Examples:

Calling the createApp operation

var params = {
  CreateApplicationRequest: { /* required */
    Name: 'STRING_VALUE', /* required */
    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)

      Specifies the display name of an application and the tags to associate with the application.

      • Namerequired — (String)

        The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console.

      • tags — (map<String>)

        A string-to-string map of key-value pairs that defines the tags to associate with the application. Each tag consists of a required tag key and an associated tag value.

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)

        Provides information about an application.

        • Arnrequired — (String)

          The Amazon Resource Name (ARN) of the application.

        • Idrequired — (String)

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

        • Namerequired — (String)

          The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console.

        • tags — (map<String>)

          A string-to-string map of key-value pairs that identifies the tags that are associated with the application. Each tag consists of a required tag key and an associated tag value.

Returns:

  • (AWS.Request)

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

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

Creates a new campaign for an application or updates the settings of an existing campaign for an application.

Service Reference:

Examples:

Calling the createCampaign operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  WriteCampaignRequest: { /* required */
    AdditionalTreatments: [
      {
        SizePercent: 'NUMBER_VALUE', /* required */
        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: {
            Title: 'STRING_VALUE', /* required */
            Body: 'STRING_VALUE',
            FromAddress: 'STRING_VALUE',
            HtmlBody: '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: {
          StartTime: 'STRING_VALUE', /* required */
          EndTime: 'STRING_VALUE',
          EventFilter: {
            Dimensions: { /* required */
              Attributes: {
                '<__string>': {
                  Values: [ /* required */
                    'STRING_VALUE',
                    /* more items */
                  ],
                  AttributeType: INCLUSIVE | EXCLUSIVE
                },
                /* '<__string>': ... */
              },
              EventType: {
                Values: [ /* required */
                  'STRING_VALUE',
                  /* more items */
                ],
                DimensionType: INCLUSIVE | EXCLUSIVE
              },
              Metrics: {
                '<__string>': {
                  ComparisonOperator: 'STRING_VALUE', /* required */
                  Value: 'NUMBER_VALUE' /* required */
                },
                /* '<__string>': ... */
              }
            },
            FilterType: SYSTEM | ENDPOINT /* required */
          },
          Frequency: ONCE | HOURLY | DAILY | WEEKLY | MONTHLY | EVENT,
          IsLocalTime: true || false,
          QuietTime: {
            End: 'STRING_VALUE',
            Start: 'STRING_VALUE'
          },
          Timezone: 'STRING_VALUE'
        },
        TemplateConfiguration: {
          EmailTemplate: {
            Name: 'STRING_VALUE'
          },
          PushTemplate: {
            Name: 'STRING_VALUE'
          },
          SMSTemplate: {
            Name: 'STRING_VALUE'
          },
          VoiceTemplate: {
            Name: 'STRING_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: {
        Title: 'STRING_VALUE', /* required */
        Body: 'STRING_VALUE',
        FromAddress: 'STRING_VALUE',
        HtmlBody: '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: {
      StartTime: 'STRING_VALUE', /* required */
      EndTime: 'STRING_VALUE',
      EventFilter: {
        Dimensions: { /* required */
          Attributes: {
            '<__string>': {
              Values: [ /* required */
                'STRING_VALUE',
                /* more items */
              ],
              AttributeType: INCLUSIVE | EXCLUSIVE
            },
            /* '<__string>': ... */
          },
          EventType: {
            Values: [ /* required */
              'STRING_VALUE',
              /* more items */
            ],
            DimensionType: INCLUSIVE | EXCLUSIVE
          },
          Metrics: {
            '<__string>': {
              ComparisonOperator: 'STRING_VALUE', /* required */
              Value: 'NUMBER_VALUE' /* required */
            },
            /* '<__string>': ... */
          }
        },
        FilterType: SYSTEM | ENDPOINT /* required */
      },
      Frequency: ONCE | HOURLY | DAILY | WEEKLY | MONTHLY | EVENT,
      IsLocalTime: true || false,
      QuietTime: {
        End: 'STRING_VALUE',
        Start: 'STRING_VALUE'
      },
      Timezone: 'STRING_VALUE'
    },
    SegmentId: 'STRING_VALUE',
    SegmentVersion: 'NUMBER_VALUE',
    TemplateConfiguration: {
      EmailTemplate: {
        Name: 'STRING_VALUE'
      },
      PushTemplate: {
        Name: 'STRING_VALUE'
      },
      SMSTemplate: {
        Name: 'STRING_VALUE'
      },
      VoiceTemplate: {
        Name: 'STRING_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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    • WriteCampaignRequest — (map)

      Specifies the configuration and other settings for a campaign.

      • AdditionalTreatments — (Array<map>)

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

        • MessageConfiguration — (map)

          The message configuration settings for the treatment.

          • ADMMessage — (map)

            The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.

            • Action — (String)

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

              • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

              • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

              • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

              Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • Body — (String)

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

            • ImageIconUrl — (String)

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

            • ImageSmallIconUrl — (String)

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

            • ImageUrl — (String)

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

            • JsonBody — (String)

              The JSON payload to use for a silent push notification.

            • MediaUrl — (String)

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

            • RawContent — (String)

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

            • SilentPush — (Boolean)

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

            • TimeToLive — (Integer)

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

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

            • Title — (String)

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

            • Url — (String)

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

          • APNSMessage — (map)

            The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.

            • Action — (String)

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

              • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

              • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

              • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

              Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • Body — (String)

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

            • ImageIconUrl — (String)

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

            • ImageSmallIconUrl — (String)

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

            • ImageUrl — (String)

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

            • JsonBody — (String)

              The JSON payload to use for a silent push notification.

            • MediaUrl — (String)

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

            • RawContent — (String)

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

            • SilentPush — (Boolean)

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

            • TimeToLive — (Integer)

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

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

            • Title — (String)

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

            • Url — (String)

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

          • BaiduMessage — (map)

            The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.

            • Action — (String)

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

              • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

              • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

              • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

              Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • Body — (String)

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

            • ImageIconUrl — (String)

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

            • ImageSmallIconUrl — (String)

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

            • ImageUrl — (String)

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

            • JsonBody — (String)

              The JSON payload to use for a silent push notification.

            • MediaUrl — (String)

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

            • RawContent — (String)

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

            • SilentPush — (Boolean)

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

            • TimeToLive — (Integer)

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

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

            • Title — (String)

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

            • Url — (String)

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

          • DefaultMessage — (map)

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

            • Action — (String)

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

              • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

              • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

              • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

              Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • Body — (String)

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

            • ImageIconUrl — (String)

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

            • ImageSmallIconUrl — (String)

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

            • ImageUrl — (String)

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

            • JsonBody — (String)

              The JSON payload to use for a silent push notification.

            • MediaUrl — (String)

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

            • RawContent — (String)

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

            • SilentPush — (Boolean)

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

            • TimeToLive — (Integer)

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

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

            • Title — (String)

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

            • Url — (String)

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

          • EmailMessage — (map)

            The message that the campaign sends through the email channel.

            • Body — (String)

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

            • FromAddress — (String)

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

            • HtmlBody — (String)

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

            • Titlerequired — (String)

              The subject line, or title, of the email.

          • GCMMessage — (map)

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

            • Action — (String)

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

              • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

              • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

              • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

              Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • Body — (String)

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

            • ImageIconUrl — (String)

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

            • ImageSmallIconUrl — (String)

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

            • ImageUrl — (String)

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

            • JsonBody — (String)

              The JSON payload to use for a silent push notification.

            • MediaUrl — (String)

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

            • RawContent — (String)

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

            • SilentPush — (Boolean)

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

            • TimeToLive — (Integer)

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

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

            • Title — (String)

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

            • Url — (String)

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

          • SMSMessage — (map)

            The message that the campaign sends through the SMS channel.

            • Body — (String)

              The body of the SMS message.

            • MessageType — (String)

              The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.

              Possible values include:
              • "TRANSACTIONAL"
              • "PROMOTIONAL"
            • SenderId — (String)

              The sender ID to display on recipients' devices when they receive the SMS message.

        • Schedule — (map)

          The schedule settings for the treatment.

          • EndTime — (String)

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

          • EventFilter — (map)

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

            • Dimensionsrequired — (map)

              The dimension settings of the event filter for the campaign.

              • Attributes — (map<map>)

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

                • AttributeType — (String)

                  The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                  Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Valuesrequired — (Array<String>)

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

              • EventType — (map)

                The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard type of event that Amazon Pinpoint generates, such as _email.delivered, or a custom event that's specific to your application.

                • DimensionType — (String)

                  The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                  Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Valuesrequired — (Array<String>)

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

              • Metrics — (map<map>)

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

                • ComparisonOperatorrequired — (String)

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

                • Valuerequired — (Float)

                  The value to compare.

            • FilterTyperequired — (String)

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

              Possible values include:
              • "SYSTEM"
              • "ENDPOINT"
          • Frequency — (String)

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

            Possible values include:
            • "ONCE"
            • "HOURLY"
            • "DAILY"
            • "WEEKLY"
            • "MONTHLY"
            • "EVENT"
          • IsLocalTime — (Boolean)

            Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.

          • QuietTime — (map)

            The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:

            • The EndpointDemographic.Timezone property of the endpoint is set to a valid value.

            • The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.

            • The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.

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

            • End — (String)

              The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

            • Start — (String)

              The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

          • StartTimerequired — (String)

            The scheduled time, in ISO 8601 format, when the campaign began or will begin.

          • Timezone — (String)

            The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.

        • SizePercentrequired — (Integer)

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

        • TemplateConfiguration — (map)

          The message template to use for the treatment.

          • EmailTemplate — (map)

            The email template to use for the message.

            • Name — (String)

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

          • PushTemplate — (map)

            The push notification template to use for the message.

            • Name — (String)

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

          • SMSTemplate — (map)

            The SMS template to use for the message.

            • Name — (String)

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

          • VoiceTemplate — (map)

            The voice template to use for the message.

            • Name — (String)

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

        • TreatmentDescription — (String)

          A custom description of the treatment.

        • TreatmentName — (String)

          The custom name of the treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.

      • Description — (String)

        A custom description of the campaign.

      • HoldoutPercent — (Integer)

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

      • Hook — (map)

        The settings for the AWS Lambda function to use as a code hook for the campaign.

        • LambdaFunctionName — (String)

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

        • Mode — (String)

          Specifies which Lambda mode to use when invoking the AWS Lambda function.

          Possible values include:
          • "DELIVERY"
          • "FILTER"
        • WebUrl — (String)

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

      • IsPaused — (Boolean)

        Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by setting this value to false.

      • Limits — (map)

        The messaging limits for the campaign.

        • Daily — (Integer)

          The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. The maximum value is 100.

        • MaximumDuration — (Integer)

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

        • MessagesPerSecond — (Integer)

          The maximum number of messages that a campaign can send each second. The minimum value is 50. The maximum value is 20,000.

        • Total — (Integer)

          The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. The maximum value is 100.

      • MessageConfiguration — (map)

        The message configuration settings for the campaign.

        • ADMMessage — (map)

          The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.

          • Action — (String)

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

            • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

            • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

            • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

            Possible values include:
            • "OPEN_APP"
            • "DEEP_LINK"
            • "URL"
          • Body — (String)

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

          • ImageIconUrl — (String)

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

          • ImageSmallIconUrl — (String)

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

          • ImageUrl — (String)

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

          • JsonBody — (String)

            The JSON payload to use for a silent push notification.

          • MediaUrl — (String)

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

          • RawContent — (String)

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

          • SilentPush — (Boolean)

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

          • TimeToLive — (Integer)

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

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

          • Title — (String)

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

          • Url — (String)

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

        • APNSMessage — (map)

          The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.

          • Action — (String)

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

            • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

            • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

            • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

            Possible values include:
            • "OPEN_APP"
            • "DEEP_LINK"
            • "URL"
          • Body — (String)

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

          • ImageIconUrl — (String)

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

          • ImageSmallIconUrl — (String)

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

          • ImageUrl — (String)

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

          • JsonBody — (String)

            The JSON payload to use for a silent push notification.

          • MediaUrl — (String)

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

          • RawContent — (String)

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

          • SilentPush — (Boolean)

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

          • TimeToLive — (Integer)

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

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

          • Title — (String)

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

          • Url — (String)

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

        • BaiduMessage — (map)

          The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.

          • Action — (String)

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

            • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

            • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

            • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

            Possible values include:
            • "OPEN_APP"
            • "DEEP_LINK"
            • "URL"
          • Body — (String)

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

          • ImageIconUrl — (String)

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

          • ImageSmallIconUrl — (String)

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

          • ImageUrl — (String)

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

          • JsonBody — (String)

            The JSON payload to use for a silent push notification.

          • MediaUrl — (String)

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

          • RawContent — (String)

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

          • SilentPush — (Boolean)

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

          • TimeToLive — (Integer)

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

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

          • Title — (String)

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

          • Url — (String)

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

        • DefaultMessage — (map)

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

          • Action — (String)

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

            • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

            • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

            • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

            Possible values include:
            • "OPEN_APP"
            • "DEEP_LINK"
            • "URL"
          • Body — (String)

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

          • ImageIconUrl — (String)

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

          • ImageSmallIconUrl — (String)

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

          • ImageUrl — (String)

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

          • JsonBody — (String)

            The JSON payload to use for a silent push notification.

          • MediaUrl — (String)

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

          • RawContent — (String)

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

          • SilentPush — (Boolean)

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

          • TimeToLive — (Integer)

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

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

          • Title — (String)

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

          • Url — (String)

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

        • EmailMessage — (map)

          The message that the campaign sends through the email channel.

          • Body — (String)

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

          • FromAddress — (String)

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

          • HtmlBody — (String)

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

          • Titlerequired — (String)

            The subject line, or title, of the email.

        • GCMMessage — (map)

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

          • Action — (String)

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

            • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

            • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

            • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

            Possible values include:
            • "OPEN_APP"
            • "DEEP_LINK"
            • "URL"
          • Body — (String)

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

          • ImageIconUrl — (String)

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

          • ImageSmallIconUrl — (String)

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

          • ImageUrl — (String)

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

          • JsonBody — (String)

            The JSON payload to use for a silent push notification.

          • MediaUrl — (String)

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

          • RawContent — (String)

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

          • SilentPush — (Boolean)

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

          • TimeToLive — (Integer)

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

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

          • Title — (String)

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

          • Url — (String)

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

        • SMSMessage — (map)

          The message that the campaign sends through the SMS channel.

          • Body — (String)

            The body of the SMS message.

          • MessageType — (String)

            The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.

            Possible values include:
            • "TRANSACTIONAL"
            • "PROMOTIONAL"
          • SenderId — (String)

            The sender ID to display on recipients' devices when they receive the SMS message.

      • Name — (String)

        The custom name of the campaign.

      • Schedule — (map)

        The schedule settings for the campaign.

        • EndTime — (String)

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

        • EventFilter — (map)

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

          • Dimensionsrequired — (map)

            The dimension settings of the event filter for the campaign.

            • Attributes — (map<map>)

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

              • AttributeType — (String)

                The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Valuesrequired — (Array<String>)

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

            • EventType — (map)

              The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard type of event that Amazon Pinpoint generates, such as _email.delivered, or a custom event that's specific to your application.

              • DimensionType — (String)

                The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Valuesrequired — (Array<String>)

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

            • Metrics — (map<map>)

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

              • ComparisonOperatorrequired — (String)

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

              • Valuerequired — (Float)

                The value to compare.

          • FilterTyperequired — (String)

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

            Possible values include:
            • "SYSTEM"
            • "ENDPOINT"
        • Frequency — (String)

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

          Possible values include:
          • "ONCE"
          • "HOURLY"
          • "DAILY"
          • "WEEKLY"
          • "MONTHLY"
          • "EVENT"
        • IsLocalTime — (Boolean)

          Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.

        • QuietTime — (map)

          The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:

          • The EndpointDemographic.Timezone property of the endpoint is set to a valid value.

          • The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.

          • The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.

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

          • End — (String)

            The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

          • Start — (String)

            The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

        • StartTimerequired — (String)

          The scheduled time, in ISO 8601 format, when the campaign began or will begin.

        • Timezone — (String)

          The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.

      • SegmentId — (String)

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

      • SegmentVersion — (Integer)

        The version of the segment to associate with the campaign.

      • tags — (map<String>)

        A string-to-string map of key-value pairs that defines the tags to associate with the campaign. Each tag consists of a required tag key and an associated tag value.

      • TemplateConfiguration — (map)

        The message template to use for the campaign.

        • EmailTemplate — (map)

          The email template to use for the message.

          • Name — (String)

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

        • PushTemplate — (map)

          The push notification template to use for the message.

          • Name — (String)

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

        • SMSTemplate — (map)

          The SMS template to use for the message.

          • Name — (String)

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

        • VoiceTemplate — (map)

          The voice template to use for the message.

          • Name — (String)

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

      • TreatmentDescription — (String)

        A custom description of a variation of the campaign to use for A/B testing.

      • TreatmentName — (String)

        The custom name of a variation of the campaign to use 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)

        Provides information about the status, configuration, and other settings for a campaign.

        • AdditionalTreatments — (Array<map>)

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

          • Idrequired — (String)

            The unique identifier for the treatment.

          • MessageConfiguration — (map)

            The message configuration settings for the treatment.

            • ADMMessage — (map)

              The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.

              • Action — (String)

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

                • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

                • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

                • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

                Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • Body — (String)

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

              • ImageIconUrl — (String)

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

              • ImageSmallIconUrl — (String)

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

              • ImageUrl — (String)

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

              • JsonBody — (String)

                The JSON payload to use for a silent push notification.

              • MediaUrl — (String)

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

              • RawContent — (String)

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

              • SilentPush — (Boolean)

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

              • TimeToLive — (Integer)

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

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

              • Title — (String)

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

              • Url — (String)

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

            • APNSMessage — (map)

              The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.

              • Action — (String)

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

                • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

                • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

                • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

                Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • Body — (String)

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

              • ImageIconUrl — (String)

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

              • ImageSmallIconUrl — (String)

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

              • ImageUrl — (String)

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

              • JsonBody — (String)

                The JSON payload to use for a silent push notification.

              • MediaUrl — (String)

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

              • RawContent — (String)

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

              • SilentPush — (Boolean)

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

              • TimeToLive — (Integer)

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

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

              • Title — (String)

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

              • Url — (String)

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

            • BaiduMessage — (map)

              The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.

              • Action — (String)

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

                • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

                • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

                • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

                Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • Body — (String)

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

              • ImageIconUrl — (String)

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

              • ImageSmallIconUrl — (String)

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

              • ImageUrl — (String)

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

              • JsonBody — (String)

                The JSON payload to use for a silent push notification.

              • MediaUrl — (String)

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

              • RawContent — (String)

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

              • SilentPush — (Boolean)

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

              • TimeToLive — (Integer)

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

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

              • Title — (String)

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

              • Url — (String)

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

            • DefaultMessage — (map)

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

              • Action — (String)

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

                • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

                • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

                • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

                Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • Body — (String)

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

              • ImageIconUrl — (String)

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

              • ImageSmallIconUrl — (String)

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

              • ImageUrl — (String)

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

              • JsonBody — (String)

                The JSON payload to use for a silent push notification.

              • MediaUrl — (String)

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

              • RawContent — (String)

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

              • SilentPush — (Boolean)

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

              • TimeToLive — (Integer)

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

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

              • Title — (String)

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

              • Url — (String)

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

            • EmailMessage — (map)

              The message that the campaign sends through the email channel.

              • Body — (String)

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

              • FromAddress — (String)

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

              • HtmlBody — (String)

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

              • Titlerequired — (String)

                The subject line, or title, of the email.

            • GCMMessage — (map)

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

              • Action — (String)

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

                • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

                • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

                • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

                Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • Body — (String)

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

              • ImageIconUrl — (String)

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

              • ImageSmallIconUrl — (String)

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

              • ImageUrl — (String)

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

              • JsonBody — (String)

                The JSON payload to use for a silent push notification.

              • MediaUrl — (String)

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

              • RawContent — (String)

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

              • SilentPush — (Boolean)

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

              • TimeToLive — (Integer)

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

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

              • Title — (String)

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

              • Url — (String)

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

            • SMSMessage — (map)

              The message that the campaign sends through the SMS channel.

              • Body — (String)

                The body of the SMS message.

              • MessageType — (String)

                The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.

                Possible values include:
                • "TRANSACTIONAL"
                • "PROMOTIONAL"
              • SenderId — (String)

                The sender ID to display on recipients' devices when they receive the SMS message.

          • Schedule — (map)

            The schedule settings for the treatment.

            • EndTime — (String)

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

            • EventFilter — (map)

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

              • Dimensionsrequired — (map)

                The dimension settings of the event filter for the campaign.

                • Attributes — (map<map>)

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

                  • AttributeType — (String)

                    The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                    Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Valuesrequired — (Array<String>)

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

                • EventType — (map)

                  The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard type of event that Amazon Pinpoint generates, such as _email.delivered, or a custom event that's specific to your application.

                  • DimensionType — (String)

                    The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                    Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Valuesrequired — (Array<String>)

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

                • Metrics — (map<map>)

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

                  • ComparisonOperatorrequired — (String)

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

                  • Valuerequired — (Float)

                    The value to compare.

              • FilterTyperequired — (String)

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

                Possible values include:
                • "SYSTEM"
                • "ENDPOINT"
            • Frequency — (String)

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

              Possible values include:
              • "ONCE"
              • "HOURLY"
              • "DAILY"
              • "WEEKLY"
              • "MONTHLY"
              • "EVENT"
            • IsLocalTime — (Boolean)

              Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.

            • QuietTime — (map)

              The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:

              • The EndpointDemographic.Timezone property of the endpoint is set to a valid value.

              • The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.

              • The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.

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

              • End — (String)

                The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

              • Start — (String)

                The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

            • StartTimerequired — (String)

              The scheduled time, in ISO 8601 format, when the campaign began or will begin.

            • Timezone — (String)

              The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.

          • SizePercentrequired — (Integer)

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

          • State — (map)

            The current status of the treatment.

            • CampaignStatus — (String)

              The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED.

              Possible values include:
              • "SCHEDULED"
              • "EXECUTING"
              • "PENDING_NEXT_RUN"
              • "COMPLETED"
              • "PAUSED"
              • "DELETED"
          • TemplateConfiguration — (map)

            The message template to use for the treatment.

            • EmailTemplate — (map)

              The email template to use for the message.

              • Name — (String)

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

            • PushTemplate — (map)

              The push notification template to use for the message.

              • Name — (String)

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

            • SMSTemplate — (map)

              The SMS template to use for the message.

              • Name — (String)

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

            • VoiceTemplate — (map)

              The voice template to use for the message.

              • Name — (String)

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

          • TreatmentDescription — (String)

            The custom description of the treatment.

          • TreatmentName — (String)

            The custom name of the treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.

        • ApplicationIdrequired — (String)

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

        • Arnrequired — (String)

          The Amazon Resource Name (ARN) of the campaign.

        • CreationDaterequired — (String)

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

        • DefaultState — (map)

          The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment, to support A/B testing.

          • CampaignStatus — (String)

            The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED.

            Possible values include:
            • "SCHEDULED"
            • "EXECUTING"
            • "PENDING_NEXT_RUN"
            • "COMPLETED"
            • "PAUSED"
            • "DELETED"
        • Description — (String)

          The custom description of the campaign.

        • HoldoutPercent — (Integer)

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

        • Hook — (map)

          The settings for the AWS Lambda function to use as a code hook for the campaign.

          • LambdaFunctionName — (String)

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

          • Mode — (String)

            Specifies which Lambda mode to use when invoking the AWS Lambda function.

            Possible values include:
            • "DELIVERY"
            • "FILTER"
          • WebUrl — (String)

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

        • Idrequired — (String)

          The unique identifier for the campaign.

        • IsPaused — (Boolean)

          Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.

        • LastModifiedDaterequired — (String)

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

        • Limits — (map)

          The messaging limits for the campaign.

          • Daily — (Integer)

            The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. The maximum value is 100.

          • MaximumDuration — (Integer)

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

          • MessagesPerSecond — (Integer)

            The maximum number of messages that a campaign can send each second. The minimum value is 50. The maximum value is 20,000.

          • Total — (Integer)

            The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. The maximum value is 100.

        • MessageConfiguration — (map)

          The message configuration settings for the campaign.

          • ADMMessage — (map)

            The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.

            • Action — (String)

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

              • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

              • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

              • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

              Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • Body — (String)

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

            • ImageIconUrl — (String)

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

            • ImageSmallIconUrl — (String)

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

            • ImageUrl — (String)

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

            • JsonBody — (String)

              The JSON payload to use for a silent push notification.

            • MediaUrl — (String)

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

            • RawContent — (String)

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

            • SilentPush — (Boolean)

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

            • TimeToLive — (Integer)

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

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

            • Title — (String)

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

            • Url — (String)

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

          • APNSMessage — (map)

            The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.

            • Action — (String)

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

              • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

              • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

              • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

              Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • Body — (String)

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

            • ImageIconUrl — (String)

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

            • ImageSmallIconUrl — (String)

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

            • ImageUrl — (String)

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

            • JsonBody — (String)

              The JSON payload to use for a silent push notification.

            • MediaUrl — (String)

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

            • RawContent — (String)

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

            • SilentPush — (Boolean)

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

            • TimeToLive — (Integer)

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

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

            • Title — (String)

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

            • Url — (String)

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

          • BaiduMessage — (map)

            The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.

            • Action — (String)

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

              • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

              • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

              • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

              Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • Body — (String)

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

            • ImageIconUrl — (String)

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

            • ImageSmallIconUrl — (String)

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

            • ImageUrl — (String)

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

            • JsonBody — (String)

              The JSON payload to use for a silent push notification.

            • MediaUrl — (String)

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

            • RawContent — (String)

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

            • SilentPush — (Boolean)

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

            • TimeToLive — (Integer)

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

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

            • Title — (String)

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

            • Url — (String)

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

          • DefaultMessage — (map)

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

            • Action — (String)

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

              • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

              • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

              • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

              Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • Body — (String)

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

            • ImageIconUrl — (String)

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

            • ImageSmallIconUrl — (String)

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

            • ImageUrl — (String)

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

            • JsonBody — (String)

              The JSON payload to use for a silent push notification.

            • MediaUrl — (String)

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

            • RawContent — (String)

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

            • SilentPush — (Boolean)

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

            • TimeToLive — (Integer)

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

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

            • Title — (String)

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

            • Url — (String)

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

          • EmailMessage — (map)

            The message that the campaign sends through the email channel.

            • Body — (String)

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

            • FromAddress — (String)

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

            • HtmlBody — (String)

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

            • Titlerequired — (String)

              The subject line, or title, of the email.

          • GCMMessage — (map)

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

            • Action — (String)

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

              • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

              • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

              • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

              Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • Body — (String)

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

            • ImageIconUrl — (String)

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

            • ImageSmallIconUrl — (String)

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

            • ImageUrl — (String)

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

            • JsonBody — (String)

              The JSON payload to use for a silent push notification.

            • MediaUrl — (String)

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

            • RawContent — (String)

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

            • SilentPush — (Boolean)

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

            • TimeToLive — (Integer)

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

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

            • Title — (String)

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

            • Url — (String)

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

          • SMSMessage — (map)

            The message that the campaign sends through the SMS channel.

            • Body — (String)

              The body of the SMS message.

            • MessageType — (String)

              The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.

              Possible values include:
              • "TRANSACTIONAL"
              • "PROMOTIONAL"
            • SenderId — (String)

              The sender ID to display on recipients' devices when they receive the SMS message.

        • Name — (String)

          The name of the campaign.

        • Schedule — (map)

          The schedule settings for the campaign.

          • EndTime — (String)

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

          • EventFilter — (map)

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

            • Dimensionsrequired — (map)

              The dimension settings of the event filter for the campaign.

              • Attributes — (map<map>)

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

                • AttributeType — (String)

                  The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                  Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Valuesrequired — (Array<String>)

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

              • EventType — (map)

                The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard type of event that Amazon Pinpoint generates, such as _email.delivered, or a custom event that's specific to your application.

                • DimensionType — (String)

                  The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                  Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Valuesrequired — (Array<String>)

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

              • Metrics — (map<map>)

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

                • ComparisonOperatorrequired — (String)

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

                • Valuerequired — (Float)

                  The value to compare.

            • FilterTyperequired — (String)

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

              Possible values include:
              • "SYSTEM"
              • "ENDPOINT"
          • Frequency — (String)

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

            Possible values include:
            • "ONCE"
            • "HOURLY"
            • "DAILY"
            • "WEEKLY"
            • "MONTHLY"
            • "EVENT"
          • IsLocalTime — (Boolean)

            Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.

          • QuietTime — (map)

            The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:

            • The EndpointDemographic.Timezone property of the endpoint is set to a valid value.

            • The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.

            • The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.

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

            • End — (String)

              The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

            • Start — (String)

              The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

          • StartTimerequired — (String)

            The scheduled time, in ISO 8601 format, when the campaign began or will begin.

          • Timezone — (String)

            The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.

        • SegmentIdrequired — (String)

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

        • SegmentVersionrequired — (Integer)

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

        • State — (map)

          The current status of the campaign.

          • CampaignStatus — (String)

            The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED.

            Possible values include:
            • "SCHEDULED"
            • "EXECUTING"
            • "PENDING_NEXT_RUN"
            • "COMPLETED"
            • "PAUSED"
            • "DELETED"
        • tags — (map<String>)

          A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.

        • TemplateConfiguration — (map)

          The message template that’s used for the campaign.

          • EmailTemplate — (map)

            The email template to use for the message.

            • Name — (String)

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

          • PushTemplate — (map)

            The push notification template to use for the message.

            • Name — (String)

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

          • SMSTemplate — (map)

            The SMS template to use for the message.

            • Name — (String)

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

          • VoiceTemplate — (map)

            The voice template to use for the message.

            • Name — (String)

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

        • TreatmentDescription — (String)

          The custom description of a variation of the campaign that's used for A/B testing.

        • TreatmentName — (String)

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

        • Version — (Integer)

          The version number of the campaign.

Returns:

  • (AWS.Request)

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

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

Creates a message template that you can use in messages that are sent through the email channel.

Service Reference:

Examples:

Calling the createEmailTemplate operation

var params = {
  EmailTemplateRequest: { /* required */
    DefaultSubstitutions: 'STRING_VALUE',
    HtmlPart: 'STRING_VALUE',
    Subject: 'STRING_VALUE',
    TemplateDescription: 'STRING_VALUE',
    TextPart: 'STRING_VALUE',
    tags: {
      '<__string>': 'STRING_VALUE',
      /* '<__string>': ... */
    }
  },
  TemplateName: 'STRING_VALUE' /* required */
};
pinpoint.createEmailTemplate(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: {})
    • EmailTemplateRequest — (map)

      Creates a new message template that you can use in messages that are sent through the email channel.

      • DefaultSubstitutions — (String)

        A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.

      • HtmlPart — (String)

        The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.

      • Subject — (String)

        The subject line, or title, to use in email messages that are based on the message template.

      • tags — (map<String>)

        A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.

      • TemplateDescription — (String)

        A custom description of the message template.

      • TextPart — (String)

        The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.

    • TemplateName — (String)

      The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

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:

      • CreateTemplateMessageBody — (map)

        Provides information about a request to create a message template.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the message template that was created.

        • Message — (String)

          The message that's returned from the API for the request to create the message template.

        • RequestID — (String)

          The unique identifier for the request to create the message template.

Returns:

  • (AWS.Request)

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

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

Creates an export job for an application.

Service Reference:

Examples:

Calling the createExportJob operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  ExportJobRequest: { /* required */
    RoleArn: 'STRING_VALUE', /* required */
    S3UrlPrefix: 'STRING_VALUE', /* required */
    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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    • ExportJobRequest — (map)

      Specifies the settings for a job that exports endpoint definitions to an Amazon Simple Storage Service (Amazon S3) bucket.

      • RoleArnrequired — (String)

        The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location where you want to export endpoint definitions to.

      • S3UrlPrefixrequired — (String)

        The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where you want to export endpoint definitions to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.

      • SegmentId — (String)

        The identifier for the segment to export endpoint definitions from. If you don't specify this value, Amazon Pinpoint exports definitions for all the endpoints that are associated with the application.

      • SegmentVersion — (Integer)

        The version of the segment to export endpoint definitions from, 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)

        Provides information about the status and settings of a job that exports endpoint definitions to a file. The file can be added directly to an Amazon Simple Storage Service (Amazon S3) bucket by using the Amazon Pinpoint API or downloaded directly to a computer by using the Amazon Pinpoint console.

        • ApplicationIdrequired — (String)

          The unique identifier for the application that's associated with the export job.

        • CompletedPieces — (Integer)

          The number of pieces that were processed successfully (completed) by the export job, as of the time of the request.

        • CompletionDate — (String)

          The date, in ISO 8601 format, when the export job was completed.

        • CreationDaterequired — (String)

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

        • Definitionrequired — (map)

          The resource settings that apply to the export job.

          • RoleArnrequired — (String)

            The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location where the endpoint definitions were exported to.

          • S3UrlPrefixrequired — (String)

            The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where the endpoint definitions were exported to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.

          • SegmentId — (String)

            The identifier for the segment that the endpoint definitions were exported from. If this value isn't present, Amazon Pinpoint exported definitions for all the endpoints that are associated with the application.

          • SegmentVersion — (Integer)

            The version of the segment that the endpoint definitions were exported from.

        • FailedPieces — (Integer)

          The number of pieces that weren't processed successfully (failed) by the export job, as of the time of the request.

        • Failures — (Array<String>)

          An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the export job, if any.

        • Idrequired — (String)

          The unique identifier for the export job.

        • JobStatusrequired — (String)

          The status of the export job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.

          Possible values include:
          • "CREATED"
          • "PREPARING_FOR_INITIALIZATION"
          • "INITIALIZING"
          • "PROCESSING"
          • "PENDING_JOB"
          • "COMPLETING"
          • "COMPLETED"
          • "FAILING"
          • "FAILED"
        • TotalFailures — (Integer)

          The total number of endpoint definitions that weren't processed successfully (failed) by the export job, typically because an error, such as a syntax error, occurred.

        • TotalPieces — (Integer)

          The total number of pieces that must be processed to complete the export job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the export job.

        • TotalProcessed — (Integer)

          The total number of endpoint definitions that were processed by the export job.

        • Typerequired — (String)

          The job type. This value is EXPORT for export jobs.

Returns:

  • (AWS.Request)

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

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

Creates an import job for an application.

Service Reference:

Examples:

Calling the createImportJob operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  ImportJobRequest: { /* required */
    Format: CSV | JSON, /* required */
    RoleArn: 'STRING_VALUE', /* required */
    S3Url: 'STRING_VALUE', /* required */
    DefineSegment: true || false,
    ExternalId: 'STRING_VALUE',
    RegisterEndpoints: true || false,
    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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    • ImportJobRequest — (map)

      Specifies the settings for a job that imports endpoint definitions from an Amazon Simple Storage Service (Amazon S3) bucket.

      • DefineSegment — (Boolean)

        Specifies whether to create a segment that contains the endpoints, when the endpoint definitions are imported.

      • ExternalId — (String)

        (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.

      • Formatrequired — (String)

        The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format. If the Amazon S3 location stores multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.

        Possible values include:
        • "CSV"
        • "JSON"
      • RegisterEndpoints — (Boolean)

        Specifies whether to register the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.

      • RoleArnrequired — (String)

        The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.

      • S3Urlrequired — (String)

        The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import. This location can be a folder or a single file. If the location is a folder, Amazon Pinpoint imports endpoint definitions from the files in this location, including any subfolders that the folder contains.

        The URL should be in the following format: s3://bucket-name/folder-name/file-name. The location can end with the key for an individual object or a prefix that qualifies multiple objects.

      • SegmentId — (String)

        The identifier for the segment to update or add the imported endpoint definitions to, if the import job is meant to update an existing segment.

      • SegmentName — (String)

        The custom name for the segment that's created by the import job, if the value of the DefineSegment property 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)

        Provides information about the status and settings of a job that imports endpoint definitions from one or more files. The files can be stored in an Amazon Simple Storage Service (Amazon S3) bucket or uploaded directly from a computer by using the Amazon Pinpoint console.

        • ApplicationIdrequired — (String)

          The unique identifier for the application that's associated with the import job.

        • CompletedPieces — (Integer)

          The number of pieces that were processed successfully (completed) by the import job, as of the time of the request.

        • CompletionDate — (String)

          The date, in ISO 8601 format, when the import job was completed.

        • CreationDaterequired — (String)

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

        • Definitionrequired — (map)

          The resource settings that apply to the import job.

          • DefineSegment — (Boolean)

            Specifies whether the import job creates a segment that contains the endpoints, when the endpoint definitions are imported.

          • ExternalId — (String)

            (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.

          • Formatrequired — (String)

            The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.

            If the files are stored in an Amazon S3 location and that location contains multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.

            Possible values include:
            • "CSV"
            • "JSON"
          • RegisterEndpoints — (Boolean)

            Specifies whether the import job registers the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.

          • RoleArnrequired — (String)

            The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.

          • S3Urlrequired — (String)

            The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import. This location can be a folder or a single file. If the location is a folder, Amazon Pinpoint imports endpoint definitions from the files in this location, including any subfolders that the folder contains.

            The URL should be in the following format: s3://bucket-name/folder-name/file-name. The location can end with the key for an individual object or a prefix that qualifies multiple objects.

          • SegmentId — (String)

            The identifier for the segment that the import job updates or adds endpoint definitions to, if the import job updates an existing segment.

          • SegmentName — (String)

            The custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.

        • FailedPieces — (Integer)

          The number of pieces that weren't processed successfully (failed) by the import job, as of the time of the request.

        • Failures — (Array<String>)

          An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the import job, if any.

        • Idrequired — (String)

          The unique identifier for the import job.

        • JobStatusrequired — (String)

          The status of the import job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.

          Possible values include:
          • "CREATED"
          • "PREPARING_FOR_INITIALIZATION"
          • "INITIALIZING"
          • "PROCESSING"
          • "PENDING_JOB"
          • "COMPLETING"
          • "COMPLETED"
          • "FAILING"
          • "FAILED"
        • TotalFailures — (Integer)

          The total number of endpoint definitions that weren't processed successfully (failed) by the import job, typically because an error, such as a syntax error, occurred.

        • TotalPieces — (Integer)

          The total number of pieces that must be processed to complete the import job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the import job.

        • TotalProcessed — (Integer)

          The total number of endpoint definitions that were processed by the import job.

        • Typerequired — (String)

          The job type. This value is IMPORT for import jobs.

Returns:

  • (AWS.Request)

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

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

Creates a journey for an application.

Service Reference:

Examples:

Calling the createJourney operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  WriteJourneyRequest: { /* required */
    Name: 'STRING_VALUE', /* required */
    Activities: {
      '<__string>': {
        ConditionalSplit: {
          Condition: {
            Conditions: [
              {
                EventCondition: {
                  Dimensions: { /* required */
                    Attributes: {
                      '<__string>': {
                        Values: [ /* required */
                          'STRING_VALUE',
                          /* more items */
                        ],
                        AttributeType: INCLUSIVE | EXCLUSIVE
                      },
                      /* '<__string>': ... */
                    },
                    EventType: {
                      Values: [ /* required */
                        'STRING_VALUE',
                        /* more items */
                      ],
                      DimensionType: INCLUSIVE | EXCLUSIVE
                    },
                    Metrics: {
                      '<__string>': {
                        ComparisonOperator: 'STRING_VALUE', /* required */
                        Value: 'NUMBER_VALUE' /* required */
                      },
                      /* '<__string>': ... */
                    }
                  },
                  MessageActivity: 'STRING_VALUE'
                },
                SegmentCondition: {
                  SegmentId: 'STRING_VALUE' /* required */
                },
                SegmentDimensions: {
                  Attributes: {
                    '<__string>': {
                      Values: [ /* required */
                        'STRING_VALUE',
                        /* more items */
                      ],
                      AttributeType: INCLUSIVE | EXCLUSIVE
                    },
                    /* '<__string>': ... */
                  },
                  Behavior: {
                    Recency: {
                      Duration: HR_24 | DAY_7 | DAY_14 | DAY_30, /* required */
                      RecencyType: ACTIVE | INACTIVE /* required */
                    }
                  },
                  Demographic: {
                    AppVersion: {
                      Values: [ /* required */
                        'STRING_VALUE',
                        /* more items */
                      ],
                      DimensionType: INCLUSIVE | EXCLUSIVE
                    },
                    Channel: {
                      Values: [ /* required */
                        'STRING_VALUE',
                        /* more items */
                      ],
                      DimensionType: INCLUSIVE | EXCLUSIVE
                    },
                    DeviceType: {
                      Values: [ /* required */
                        'STRING_VALUE',
                        /* more items */
                      ],
                      DimensionType: INCLUSIVE | EXCLUSIVE
                    },
                    Make: {
                      Values: [ /* required */
                        'STRING_VALUE',
                        /* more items */
                      ],
                      DimensionType: INCLUSIVE | EXCLUSIVE
                    },
                    Model: {
                      Values: [ /* required */
                        'STRING_VALUE',
                        /* more items */
                      ],
                      DimensionType: INCLUSIVE | EXCLUSIVE
                    },
                    Platform: {
                      Values: [ /* required */
                        'STRING_VALUE',
                        /* more items */
                      ],
                      DimensionType: INCLUSIVE | EXCLUSIVE
                    }
                  },
                  Location: {
                    Country: {
                      Values: [ /* required */
                        'STRING_VALUE',
                        /* more items */
                      ],
                      DimensionType: INCLUSIVE | EXCLUSIVE
                    },
                    GPSPoint: {
                      Coordinates: { /* required */
                        Latitude: 'NUMBER_VALUE', /* required */
                        Longitude: 'NUMBER_VALUE' /* required */
                      },
                      RangeInKilometers: 'NUMBER_VALUE'
                    }
                  },
                  Metrics: {
                    '<__string>': {
                      ComparisonOperator: 'STRING_VALUE', /* required */
                      Value: 'NUMBER_VALUE' /* required */
                    },
                    /* '<__string>': ... */
                  },
                  UserAttributes: {
                    '<__string>': {
                      Values: [ /* required */
                        'STRING_VALUE',
                        /* more items */
                      ],
                      AttributeType: INCLUSIVE | EXCLUSIVE
                    },
                    /* '<__string>': ... */
                  }
                }
              },
              /* more items */
            ],
            Operator: ALL | ANY
          },
          EvaluationWaitTime: {
            WaitFor: 'STRING_VALUE',
            WaitUntil: 'STRING_VALUE'
          },
          FalseActivity: 'STRING_VALUE',
          TrueActivity: 'STRING_VALUE'
        },
        Description: 'STRING_VALUE',
        EMAIL: {
          MessageConfig: {
            FromAddress: 'STRING_VALUE'
          },
          NextActivity: 'STRING_VALUE',
          TemplateName: 'STRING_VALUE'
        },
        Holdout: {
          Percentage: 'NUMBER_VALUE', /* required */
          NextActivity: 'STRING_VALUE'
        },
        MultiCondition: {
          Branches: [
            {
              Condition: {
                EventCondition: {
                  Dimensions: { /* required */
                    Attributes: {
                      '<__string>': {
                        Values: [ /* required */
                          'STRING_VALUE',
                          /* more items */
                        ],
                        AttributeType: INCLUSIVE | EXCLUSIVE
                      },
                      /* '<__string>': ... */
                    },
                    EventType: {
                      Values: [ /* required */
                        'STRING_VALUE',
                        /* more items */
                      ],
                      DimensionType: INCLUSIVE | EXCLUSIVE
                    },
                    Metrics: {
                      '<__string>': {
                        ComparisonOperator: 'STRING_VALUE', /* required */
                        Value: 'NUMBER_VALUE' /* required */
                      },
                      /* '<__string>': ... */
                    }
                  },
                  MessageActivity: 'STRING_VALUE'
                },
                SegmentCondition: {
                  SegmentId: 'STRING_VALUE' /* required */
                },
                SegmentDimensions: {
                  Attributes: {
                    '<__string>': {
                      Values: [ /* required */
                        'STRING_VALUE',
                        /* more items */
                      ],
                      AttributeType: INCLUSIVE | EXCLUSIVE
                    },
                    /* '<__string>': ... */
                  },
                  Behavior: {
                    Recency: {
                      Duration: HR_24 | DAY_7 | DAY_14 | DAY_30, /* required */
                      RecencyType: ACTIVE | INACTIVE /* required */
                    }
                  },
                  Demographic: {
                    AppVersion: {
                      Values: [ /* required */
                        'STRING_VALUE',
                        /* more items */
                      ],
                      DimensionType: INCLUSIVE | EXCLUSIVE
                    },
                    Channel: {
                      Values: [ /* required */
                        'STRING_VALUE',
                        /* more items */
                      ],
                      DimensionType: INCLUSIVE | EXCLUSIVE
                    },
                    DeviceType: {
                      Values: [ /* required */
                        'STRING_VALUE',
                        /* more items */
                      ],
                      DimensionType: INCLUSIVE | EXCLUSIVE
                    },
                    Make: {
                      Values: [ /* required */
                        'STRING_VALUE',
                        /* more items */
                      ],
                      DimensionType: INCLUSIVE | EXCLUSIVE
                    },
                    Model: {
                      Values: [ /* required */
                        'STRING_VALUE',
                        /* more items */
                      ],
                      DimensionType: INCLUSIVE | EXCLUSIVE
                    },
                    Platform: {
                      Values: [ /* required */
                        'STRING_VALUE',
                        /* more items */
                      ],
                      DimensionType: INCLUSIVE | EXCLUSIVE
                    }
                  },
                  Location: {
                    Country: {
                      Values: [ /* required */
                        'STRING_VALUE',
                        /* more items */
                      ],
                      DimensionType: INCLUSIVE | EXCLUSIVE
                    },
                    GPSPoint: {
                      Coordinates: { /* required */
                        Latitude: 'NUMBER_VALUE', /* required */
                        Longitude: 'NUMBER_VALUE' /* required */
                      },
                      RangeInKilometers: 'NUMBER_VALUE'
                    }
                  },
                  Metrics: {
                    '<__string>': {
                      ComparisonOperator: 'STRING_VALUE', /* required */
                      Value: 'NUMBER_VALUE' /* required */
                    },
                    /* '<__string>': ... */
                  },
                  UserAttributes: {
                    '<__string>': {
                      Values: [ /* required */
                        'STRING_VALUE',
                        /* more items */
                      ],
                      AttributeType: INCLUSIVE | EXCLUSIVE
                    },
                    /* '<__string>': ... */
                  }
                }
              },
              NextActivity: 'STRING_VALUE'
            },
            /* more items */
          ],
          DefaultActivity: 'STRING_VALUE',
          EvaluationWaitTime: {
            WaitFor: 'STRING_VALUE',
            WaitUntil: 'STRING_VALUE'
          }
        },
        RandomSplit: {
          Branches: [
            {
              NextActivity: 'STRING_VALUE',
              Percentage: 'NUMBER_VALUE'
            },
            /* more items */
          ]
        },
        Wait: {
          NextActivity: 'STRING_VALUE',
          WaitTime: {
            WaitFor: 'STRING_VALUE',
            WaitUntil: 'STRING_VALUE'
          }
        }
      },
      /* '<__string>': ... */
    },
    CreationDate: 'STRING_VALUE',
    LastModifiedDate: 'STRING_VALUE',
    Limits: {
      DailyCap: 'NUMBER_VALUE',
      EndpointReentryCap: 'NUMBER_VALUE',
      MessagesPerSecond: 'NUMBER_VALUE'
    },
    LocalTime: true || false,
    QuietTime: {
      End: 'STRING_VALUE',
      Start: 'STRING_VALUE'
    },
    RefreshFrequency: 'STRING_VALUE',
    Schedule: {
      EndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
      StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
      Timezone: 'STRING_VALUE'
    },
    StartActivity: 'STRING_VALUE',
    StartCondition: {
      Description: 'STRING_VALUE',
      SegmentStartCondition: {
        SegmentId: 'STRING_VALUE' /* required */
      }
    },
    State: DRAFT | ACTIVE | COMPLETED | CANCELLED | CLOSED
  }
};
pinpoint.createJourney(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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    • WriteJourneyRequest — (map)

      Specifies the configuration and other settings for a journey.

      • Activities — (map<map>)

        The configuration and other settings for the activities that comprise the journey.

        • ConditionalSplit — (map)

          The settings for a yes/no split activity. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify.

          • Condition — (map)

            The conditions that define the paths for the activity, and the relationship between the conditions.

            • Conditions — (Array<map>)

              The conditions to evaluate for the activity.

              • EventCondition — (map)

                The dimension settings for the event that's associated with the activity.

                • Dimensionsrequired — (map)

                  The dimensions for the event filter to use for the activity.

                  • Attributes — (map<map>)

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

                    • AttributeType — (String)

                      The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                      Possible values include:
                      • "INCLUSIVE"
                      • "EXCLUSIVE"
                    • Valuesrequired — (Array<String>)

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

                  • EventType — (map)

                    The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard type of event that Amazon Pinpoint generates, such as _email.delivered, or a custom event that's specific to your application.

                    • DimensionType — (String)

                      The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                      Possible values include:
                      • "INCLUSIVE"
                      • "EXCLUSIVE"
                    • Valuesrequired — (Array<String>)

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

                  • Metrics — (map<map>)

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

                    • ComparisonOperatorrequired — (String)

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

                    • Valuerequired — (Float)

                      The value to compare.

                • MessageActivity — (String)

                  The message identifier (message_id) for the message to use when determining whether message events meet the condition.

              • SegmentCondition — (map)

                The segment that's associated with the activity.

                • SegmentIdrequired — (String)

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

              • SegmentDimensions — (map)

                The dimension settings for the segment that's associated with the activity.

                • Attributes — (map<map>)

                  One or more custom attributes to use as criteria for the segment.

                  • AttributeType — (String)

                    The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                    Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Valuesrequired — (Array<String>)

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

                • Behavior — (map)

                  The behavior-based criteria, such as how recently users have used your app, for the segment.

                  • Recency — (map)

                    The dimension settings that are based on how recently an endpoint was active.

                    • Durationrequired — (String)

                      The duration to use when determining whether an endpoint is active or inactive.

                      Possible values include:
                      • "HR_24"
                      • "DAY_7"
                      • "DAY_14"
                      • "DAY_30"
                    • RecencyTyperequired — (String)

                      The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.

                      Possible values include:
                      • "ACTIVE"
                      • "INACTIVE"
                • Demographic — (map)

                  The demographic-based criteria, such as device platform, for the segment.

                  • AppVersion — (map)

                    The app version criteria for the segment.

                    • DimensionType — (String)

                      The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                      Possible values include:
                      • "INCLUSIVE"
                      • "EXCLUSIVE"
                    • Valuesrequired — (Array<String>)

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

                  • Channel — (map)

                    The channel criteria for the segment.

                    • DimensionType — (String)

                      The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                      Possible values include:
                      • "INCLUSIVE"
                      • "EXCLUSIVE"
                    • Valuesrequired — (Array<String>)

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

                  • DeviceType — (map)

                    The device type criteria for the segment.

                    • DimensionType — (String)

                      The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                      Possible values include:
                      • "INCLUSIVE"
                      • "EXCLUSIVE"
                    • Valuesrequired — (Array<String>)

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

                  • Make — (map)

                    The device make criteria for the segment.

                    • DimensionType — (String)

                      The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                      Possible values include:
                      • "INCLUSIVE"
                      • "EXCLUSIVE"
                    • Valuesrequired — (Array<String>)

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

                  • Model — (map)

                    The device model criteria for the segment.

                    • DimensionType — (String)

                      The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                      Possible values include:
                      • "INCLUSIVE"
                      • "EXCLUSIVE"
                    • Valuesrequired — (Array<String>)

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

                  • Platform — (map)

                    The device platform criteria for the segment.

                    • DimensionType — (String)

                      The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                      Possible values include:
                      • "INCLUSIVE"
                      • "EXCLUSIVE"
                    • Valuesrequired — (Array<String>)

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

                • Location — (map)

                  The location-based criteria, such as region or GPS coordinates, for the segment.

                  • Country — (map)

                    The country or region code, in ISO 3166-1 alpha-2 format, for the segment.

                    • DimensionType — (String)

                      The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                      Possible values include:
                      • "INCLUSIVE"
                      • "EXCLUSIVE"
                    • Valuesrequired — (Array<String>)

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

                  • GPSPoint — (map)

                    The GPS location and range for the segment.

                    • Coordinatesrequired — (map)

                      The GPS coordinates to measure distance from.

                      • Latituderequired — (Float)

                        The latitude coordinate of the location.

                      • Longituderequired — (Float)

                        The longitude coordinate of the location.

                    • RangeInKilometers — (Float)

                      The range, in kilometers, from the GPS coordinates.

                • Metrics — (map<map>)

                  One or more custom metrics to use as criteria for the segment.

                  • ComparisonOperatorrequired — (String)

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

                  • Valuerequired — (Float)

                    The value to compare.

                • UserAttributes — (map<map>)

                  One or more custom user attributes to use as criteria for the segment.

                  • AttributeType — (String)

                    The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                    Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Valuesrequired — (Array<String>)

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

            • Operator — (String)

              Specifies how to handle multiple conditions for the activity. For example, if you specify two conditions for an activity, whether both or only one of the conditions must be met for the activity to be performed.

              Possible values include:
              • "ALL"
              • "ANY"
          • EvaluationWaitTime — (map)

            The amount of time to wait before determining whether the conditions are met, or the date and time when Amazon Pinpoint determines whether the conditions are met.

            • WaitFor — (String)

              The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.

            • WaitUntil — (String)

              The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.

          • FalseActivity — (String)

            The unique identifier for the activity to perform if the condition isn't met.

          • TrueActivity — (String)

            The unique identifier for the activity to perform if the condition is met.

        • Description — (String)

          The custom description of the activity.

        • EMAIL — (map)

          The settings for an email activity. This type of activity sends an email message to participants.

          • MessageConfig — (map)

            The "From" address to use for the message.

            • FromAddress — (String)

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

          • NextActivity — (String)

            The unique identifier for the next activity to perform, after the message is sent.

          • TemplateName — (String)

            The name of the email template to use for the message.

        • Holdout — (map)

          The settings for a holdout activity. This type of activity stops a journey for a specified percentage of participants.

          • NextActivity — (String)

            The unique identifier for the next activity to perform, after performing the holdout activity.

          • Percentagerequired — (Integer)

            The percentage of participants who shouldn't continue the journey.

        • MultiCondition — (map)

          The settings for a multivariate split activity. This type of activity sends participants down one of as many as five paths in a journey, based on conditions that you specify.

          • Branches — (Array<map>)

            The paths for the activity, including the conditions for entering each path and the activity to perform for each path.

            • Condition — (map)

              The condition to evaluate for the activity path.

              • EventCondition — (map)

                The dimension settings for the event that's associated with the activity.

                • Dimensionsrequired — (map)

                  The dimensions for the event filter to use for the activity.

                  • Attributes — (map<map>)

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

                    • AttributeType — (String)

                      The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                      Possible values include:
                      • "INCLUSIVE"
                      • "EXCLUSIVE"
                    • Valuesrequired — (Array<String>)

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

                  • EventType — (map)

                    The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard type of event that Amazon Pinpoint generates, such as _email.delivered, or a custom event that's specific to your application.

                    • DimensionType — (String)

                      The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                      Possible values include:
                      • "INCLUSIVE"
                      • "EXCLUSIVE"
                    • Valuesrequired — (Array<String>)

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

                  • Metrics — (map<map>)

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

                    • ComparisonOperatorrequired — (String)

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

                    • Valuerequired — (Float)

                      The value to compare.

                • MessageActivity — (String)

                  The message identifier (message_id) for the message to use when determining whether message events meet the condition.

              • SegmentCondition — (map)

                The segment that's associated with the activity.

                • SegmentIdrequired — (String)

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

              • SegmentDimensions — (map)

                The dimension settings for the segment that's associated with the activity.

                • Attributes — (map<map>)

                  One or more custom attributes to use as criteria for the segment.

                  • AttributeType — (String)

                    The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                    Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Valuesrequired — (Array<String>)

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

                • Behavior — (map)

                  The behavior-based criteria, such as how recently users have used your app, for the segment.

                  • Recency — (map)

                    The dimension settings that are based on how recently an endpoint was active.

                    • Durationrequired — (String)

                      The duration to use when determining whether an endpoint is active or inactive.

                      Possible values include:
                      • "HR_24"
                      • "DAY_7"
                      • "DAY_14"
                      • "DAY_30"
                    • RecencyTyperequired — (String)

                      The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.

                      Possible values include:
                      • "ACTIVE"
                      • "INACTIVE"
                • Demographic — (map)

                  The demographic-based criteria, such as device platform, for the segment.

                  • AppVersion — (map)

                    The app version criteria for the segment.

                    • DimensionType — (String)

                      The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                      Possible values include:
                      • "INCLUSIVE"
                      • "EXCLUSIVE"
                    • Valuesrequired — (Array<String>)

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

                  • Channel — (map)

                    The channel criteria for the segment.

                    • DimensionType — (String)

                      The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                      Possible values include:
                      • "INCLUSIVE"
                      • "EXCLUSIVE"
                    • Valuesrequired — (Array<String>)

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

                  • DeviceType — (map)

                    The device type criteria for the segment.

                    • DimensionType — (String)

                      The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                      Possible values include:
                      • "INCLUSIVE"
                      • "EXCLUSIVE"
                    • Valuesrequired — (Array<String>)

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

                  • Make — (map)

                    The device make criteria for the segment.

                    • DimensionType — (String)

                      The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                      Possible values include:
                      • "INCLUSIVE"
                      • "EXCLUSIVE"
                    • Valuesrequired — (Array<String>)

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

                  • Model — (map)

                    The device model criteria for the segment.

                    • DimensionType — (String)

                      The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                      Possible values include:
                      • "INCLUSIVE"
                      • "EXCLUSIVE"
                    • Valuesrequired — (Array<String>)

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

                  • Platform — (map)

                    The device platform criteria for the segment.

                    • DimensionType — (String)

                      The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                      Possible values include:
                      • "INCLUSIVE"
                      • "EXCLUSIVE"
                    • Valuesrequired — (Array<String>)

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

                • Location — (map)

                  The location-based criteria, such as region or GPS coordinates, for the segment.

                  • Country — (map)

                    The country or region code, in ISO 3166-1 alpha-2 format, for the segment.

                    • DimensionType — (String)

                      The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                      Possible values include:
                      • "INCLUSIVE"
                      • "EXCLUSIVE"
                    • Valuesrequired — (Array<String>)

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

                  • GPSPoint — (map)

                    The GPS location and range for the segment.

                    • Coordinatesrequired — (map)

                      The GPS coordinates to measure distance from.

                      • Latituderequired — (Float)

                        The latitude coordinate of the location.

                      • Longituderequired — (Float)

                        The longitude coordinate of the location.

                    • RangeInKilometers — (Float)

                      The range, in kilometers, from the GPS coordinates.

                • Metrics — (map<map>)

                  One or more custom metrics to use as criteria for the segment.

                  • ComparisonOperatorrequired — (String)

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

                  • Valuerequired — (Float)

                    The value to compare.

                • UserAttributes — (map<map>)

                  One or more custom user attributes to use as criteria for the segment.

                  • AttributeType — (String)

                    The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                    Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Valuesrequired — (Array<String>)

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

            • NextActivity — (String)

              The unique identifier for the next activity to perform, after completing the activity for the path.

          • DefaultActivity — (String)

            The activity to perform by default for any path in the activity.

          • EvaluationWaitTime — (map)

            The amount of time to wait or the date and time when Amazon Pinpoint determines whether the conditions are met.

            • WaitFor — (String)

              The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.

            • WaitUntil — (String)

              The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.

        • RandomSplit — (map)

          The settings for a random split activity. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify.

          • Branches — (Array<map>)

            The paths for the activity, including the percentage of participants to enter each path and the activity to perform for each path.

            • NextActivity — (String)

              The unique identifier for the next activity to perform, after completing the activity for the path.

            • Percentage — (Integer)

              The percentage of participants to send down the activity path.

        • Wait — (map)

          The settings for a wait activity. This type of activity waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.

          • NextActivity — (String)

            The unique identifier for the next activity to perform, after performing the wait activity.

          • WaitTime — (map)

            The amount of time to wait or the date and time when the activity moves participants to the next activity in the journey.

            • WaitFor — (String)

              The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.

            • WaitUntil — (String)

              The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.

      • CreationDate — (String)

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

      • LastModifiedDate — (String)

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

      • Limits — (map)

        The messaging and entry limits for the journey.

        • DailyCap — (Integer)

          The maximum number of messages that the journey can send to a single participant during a 24-hour period. The maximum value is 100.

        • EndpointReentryCap — (Integer)

          The maximum number of times that a participant can enter the journey. The maximum value is 100. To allow participants to enter the journey an unlimited number of times, set this value to 0.

        • MessagesPerSecond — (Integer)

          The maximum number of messages that the journey can send each second.

      • LocalTime — (Boolean)

        Specifies whether the journey's scheduled start and end times use each participant's local time. To base the schedule on each participant's local time, set this value to true.

      • Namerequired — (String)

        The name of the journey. A journey name can contain a maximum of 150 characters. The characters can be alphanumeric characters or symbols, such as underscores (_) or hyphens (-). A journey name can't contain any spaces.

      • QuietTime — (map)

        The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:

        • The EndpointDemographic.Timezone property of the endpoint for the participant is set to a valid value.

        • The current time in the participant's time zone is later than or equal to the time specified by the QuietTime.Start property for the journey.

        • The current time in the participant's time zone is earlier than or equal to the time specified by the QuietTime.End property for the journey.

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

        • End — (String)

          The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

        • Start — (String)

          The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

      • RefreshFrequency — (String)

        The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.

      • Schedule — (map)

        The schedule settings for the journey.

        • EndTime — (Date)

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

        • StartTime — (Date)

          The scheduled time, in ISO 8601 format, when the journey began or will begin.

        • Timezone — (String)

          The starting UTC offset for the journey schedule, if the value of the journey's LocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+08:45, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+12:45, UTC+13, UTC+13:45, UTC-02, UTC-02:30, UTC-03, UTC-03:30, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-09:30, UTC-10, and UTC-11.

      • StartActivity — (String)

        The unique identifier for the first activity in the journey.

      • StartCondition — (map)

        The segment that defines which users are participants in the journey.

        • Description — (String)

          The custom description of the condition.

        • SegmentStartCondition — (map)

          The segment that's associated with the first activity in the journey. This segment determines which users are participants in the journey.

          • SegmentIdrequired — (String)

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

      • State — (String)

        The status of the journey. Valid values are:

        • DRAFT - Saves the journey and doesn't publish it.

        • ACTIVE - Saves and publishes the journey. Depending on the journey's schedule, the journey starts running immediately or at the scheduled start time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.

        The CANCELLED, COMPLETED, and CLOSED values are not supported in requests to create or update a journey. To cancel a journey, use the Journey State resource.

        Possible values include:
        • "DRAFT"
        • "ACTIVE"
        • "COMPLETED"
        • "CANCELLED"
        • "CLOSED"

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:

      • JourneyResponse — (map)

        Provides information about the status, configuration, and other settings for a journey.

        • Activities — (map<map>)

          The configuration and other settings for the activities that comprise the journey.

          • ConditionalSplit — (map)

            The settings for a yes/no split activity. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify.

            • Condition — (map)

              The conditions that define the paths for the activity, and the relationship between the conditions.

              • Conditions — (Array<map>)

                The conditions to evaluate for the activity.

                • EventCondition — (map)

                  The dimension settings for the event that's associated with the activity.

                  • Dimensionsrequired — (map)

                    The dimensions for the event filter to use for the activity.

                    • Attributes — (map<map>)

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

                      • AttributeType — (String)

                        The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                        Possible values include:
                        • "INCLUSIVE"
                        • "EXCLUSIVE"
                      • Valuesrequired — (Array<String>)

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

                    • EventType — (map)

                      The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard type of event that Amazon Pinpoint generates, such as _email.delivered, or a custom event that's specific to your application.

                      • DimensionType — (String)

                        The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                        Possible values include:
                        • "INCLUSIVE"
                        • "EXCLUSIVE"
                      • Valuesrequired — (Array<String>)

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

                    • Metrics — (map<map>)

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

                      • ComparisonOperatorrequired — (String)

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

                      • Valuerequired — (Float)

                        The value to compare.

                  • MessageActivity — (String)

                    The message identifier (message_id) for the message to use when determining whether message events meet the condition.

                • SegmentCondition — (map)

                  The segment that's associated with the activity.

                  • SegmentIdrequired — (String)

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

                • SegmentDimensions — (map)

                  The dimension settings for the segment that's associated with the activity.

                  • Attributes — (map<map>)

                    One or more custom attributes to use as criteria for the segment.

                    • AttributeType — (String)

                      The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                      Possible values include:
                      • "INCLUSIVE"
                      • "EXCLUSIVE"
                    • Valuesrequired — (Array<String>)

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

                  • Behavior — (map)

                    The behavior-based criteria, such as how recently users have used your app, for the segment.

                    • Recency — (map)

                      The dimension settings that are based on how recently an endpoint was active.

                      • Durationrequired — (String)

                        The duration to use when determining whether an endpoint is active or inactive.

                        Possible values include:
                        • "HR_24"
                        • "DAY_7"
                        • "DAY_14"
                        • "DAY_30"
                      • RecencyTyperequired — (String)

                        The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.

                        Possible values include:
                        • "ACTIVE"
                        • "INACTIVE"
                  • Demographic — (map)

                    The demographic-based criteria, such as device platform, for the segment.

                    • AppVersion — (map)

                      The app version criteria for the segment.

                      • DimensionType — (String)

                        The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                        Possible values include:
                        • "INCLUSIVE"
                        • "EXCLUSIVE"
                      • Valuesrequired — (Array<String>)

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

                    • Channel — (map)

                      The channel criteria for the segment.

                      • DimensionType — (String)

                        The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                        Possible values include:
                        • "INCLUSIVE"
                        • "EXCLUSIVE"
                      • Valuesrequired — (Array<String>)

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

                    • DeviceType — (map)

                      The device type criteria for the segment.

                      • DimensionType — (String)

                        The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                        Possible values include:
                        • "INCLUSIVE"
                        • "EXCLUSIVE"
                      • Valuesrequired — (Array<String>)

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

                    • Make — (map)

                      The device make criteria for the segment.

                      • DimensionType — (String)

                        The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                        Possible values include:
                        • "INCLUSIVE"
                        • "EXCLUSIVE"
                      • Valuesrequired — (Array<String>)

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

                    • Model — (map)

                      The device model criteria for the segment.

                      • DimensionType — (String)

                        The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                        Possible values include:
                        • "INCLUSIVE"
                        • "EXCLUSIVE"
                      • Valuesrequired — (Array<String>)

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

                    • Platform — (map)

                      The device platform criteria for the segment.

                      • DimensionType — (String)

                        The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                        Possible values include:
                        • "INCLUSIVE"
                        • "EXCLUSIVE"
                      • Valuesrequired — (Array<String>)

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

                  • Location — (map)

                    The location-based criteria, such as region or GPS coordinates, for the segment.

                    • Country — (map)

                      The country or region code, in ISO 3166-1 alpha-2 format, for the segment.

                      • DimensionType — (String)

                        The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                        Possible values include:
                        • "INCLUSIVE"
                        • "EXCLUSIVE"
                      • Valuesrequired — (Array<String>)

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

                    • GPSPoint — (map)

                      The GPS location and range for the segment.

                      • Coordinatesrequired — (map)

                        The GPS coordinates to measure distance from.

                        • Latituderequired — (Float)

                          The latitude coordinate of the location.

                        • Longituderequired — (Float)

                          The longitude coordinate of the location.

                      • RangeInKilometers — (Float)

                        The range, in kilometers, from the GPS coordinates.

                  • Metrics — (map<map>)

                    One or more custom metrics to use as criteria for the segment.

                    • ComparisonOperatorrequired — (String)

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

                    • Valuerequired — (Float)

                      The value to compare.

                  • UserAttributes — (map<map>)

                    One or more custom user attributes to use as criteria for the segment.

                    • AttributeType — (String)

                      The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                      Possible values include:
                      • "INCLUSIVE"
                      • "EXCLUSIVE"
                    • Valuesrequired — (Array<String>)

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

              • Operator — (String)

                Specifies how to handle multiple conditions for the activity. For example, if you specify two conditions for an activity, whether both or only one of the conditions must be met for the activity to be performed.

                Possible values include:
                • "ALL"
                • "ANY"
            • EvaluationWaitTime — (map)

              The amount of time to wait before determining whether the conditions are met, or the date and time when Amazon Pinpoint determines whether the conditions are met.

              • WaitFor — (String)

                The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.

              • WaitUntil — (String)

                The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.

            • FalseActivity — (String)

              The unique identifier for the activity to perform if the condition isn't met.

            • TrueActivity — (String)

              The unique identifier for the activity to perform if the condition is met.

          • Description — (String)

            The custom description of the activity.

          • EMAIL — (map)

            The settings for an email activity. This type of activity sends an email message to participants.

            • MessageConfig — (map)

              The "From" address to use for the message.

              • FromAddress — (String)

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

            • NextActivity — (String)

              The unique identifier for the next activity to perform, after the message is sent.

            • TemplateName — (String)

              The name of the email template to use for the message.

          • Holdout — (map)

            The settings for a holdout activity. This type of activity stops a journey for a specified percentage of participants.

            • NextActivity — (String)

              The unique identifier for the next activity to perform, after performing the holdout activity.

            • Percentagerequired — (Integer)

              The percentage of participants who shouldn't continue the journey.

          • MultiCondition — (map)

            The settings for a multivariate split activity. This type of activity sends participants down one of as many as five paths in a journey, based on conditions that you specify.

            • Branches — (Array<map>)

              The paths for the activity, including the conditions for entering each path and the activity to perform for each path.

              • Condition — (map)

                The condition to evaluate for the activity path.

                • EventCondition — (map)

                  The dimension settings for the event that's associated with the activity.

                  • Dimensionsrequired — (map)

                    The dimensions for the event filter to use for the activity.

                    • Attributes — (map<map>)

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

                      • AttributeType — (String)

                        The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                        Possible values include:
                        • "INCLUSIVE"
                        • "EXCLUSIVE"
                      • Valuesrequired — (Array<String>)

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

                    • EventType — (map)

                      The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard type of event that Amazon Pinpoint generates, such as _email.delivered, or a custom event that's specific to your application.

                      • DimensionType — (String)

                        The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                        Possible values include:
                        • "INCLUSIVE"
                        • "EXCLUSIVE"
                      • Valuesrequired — (Array<String>)

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

                    • Metrics — (map<map>)

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

                      • ComparisonOperatorrequired — (String)

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

                      • Valuerequired — (Float)

                        The value to compare.

                  • MessageActivity — (String)

                    The message identifier (message_id) for the message to use when determining whether message events meet the condition.

                • SegmentCondition — (map)

                  The segment that's associated with the activity.

                  • SegmentIdrequired — (String)

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

                • SegmentDimensions — (map)

                  The dimension settings for the segment that's associated with the activity.

                  • Attributes — (map<map>)

                    One or more custom attributes to use as criteria for the segment.

                    • AttributeType — (String)

                      The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                      Possible values include:
                      • "INCLUSIVE"
                      • "EXCLUSIVE"
                    • Valuesrequired — (Array<String>)

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

                  • Behavior — (map)

                    The behavior-based criteria, such as how recently users have used your app, for the segment.

                    • Recency — (map)

                      The dimension settings that are based on how recently an endpoint was active.

                      • Durationrequired — (String)

                        The duration to use when determining whether an endpoint is active or inactive.

                        Possible values include:
                        • "HR_24"
                        • "DAY_7"
                        • "DAY_14"
                        • "DAY_30"
                      • RecencyTyperequired — (String)

                        The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.

                        Possible values include:
                        • "ACTIVE"
                        • "INACTIVE"
                  • Demographic — (map)

                    The demographic-based criteria, such as device platform, for the segment.

                    • AppVersion — (map)

                      The app version criteria for the segment.

                      • DimensionType — (String)

                        The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                        Possible values include:
                        • "INCLUSIVE"
                        • "EXCLUSIVE"
                      • Valuesrequired — (Array<String>)

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

                    • Channel — (map)

                      The channel criteria for the segment.

                      • DimensionType — (String)

                        The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                        Possible values include:
                        • "INCLUSIVE"
                        • "EXCLUSIVE"
                      • Valuesrequired — (Array<String>)

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

                    • DeviceType — (map)

                      The device type criteria for the segment.

                      • DimensionType — (String)

                        The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                        Possible values include:
                        • "INCLUSIVE"
                        • "EXCLUSIVE"
                      • Valuesrequired — (Array<String>)

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

                    • Make — (map)

                      The device make criteria for the segment.

                      • DimensionType — (String)

                        The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                        Possible values include:
                        • "INCLUSIVE"
                        • "EXCLUSIVE"
                      • Valuesrequired — (Array<String>)

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

                    • Model — (map)

                      The device model criteria for the segment.

                      • DimensionType — (String)

                        The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                        Possible values include:
                        • "INCLUSIVE"
                        • "EXCLUSIVE"
                      • Valuesrequired — (Array<String>)

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

                    • Platform — (map)

                      The device platform criteria for the segment.

                      • DimensionType — (String)

                        The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                        Possible values include:
                        • "INCLUSIVE"
                        • "EXCLUSIVE"
                      • Valuesrequired — (Array<String>)

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

                  • Location — (map)

                    The location-based criteria, such as region or GPS coordinates, for the segment.

                    • Country — (map)

                      The country or region code, in ISO 3166-1 alpha-2 format, for the segment.

                      • DimensionType — (String)

                        The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                        Possible values include:
                        • "INCLUSIVE"
                        • "EXCLUSIVE"
                      • Valuesrequired — (Array<String>)

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

                    • GPSPoint — (map)

                      The GPS location and range for the segment.

                      • Coordinatesrequired — (map)

                        The GPS coordinates to measure distance from.

                        • Latituderequired — (Float)

                          The latitude coordinate of the location.

                        • Longituderequired — (Float)

                          The longitude coordinate of the location.

                      • RangeInKilometers — (Float)

                        The range, in kilometers, from the GPS coordinates.

                  • Metrics — (map<map>)

                    One or more custom metrics to use as criteria for the segment.

                    • ComparisonOperatorrequired — (String)

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

                    • Valuerequired — (Float)

                      The value to compare.

                  • UserAttributes — (map<map>)

                    One or more custom user attributes to use as criteria for the segment.

                    • AttributeType — (String)

                      The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                      Possible values include:
                      • "INCLUSIVE"
                      • "EXCLUSIVE"
                    • Valuesrequired — (Array<String>)

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

              • NextActivity — (String)

                The unique identifier for the next activity to perform, after completing the activity for the path.

            • DefaultActivity — (String)

              The activity to perform by default for any path in the activity.

            • EvaluationWaitTime — (map)

              The amount of time to wait or the date and time when Amazon Pinpoint determines whether the conditions are met.

              • WaitFor — (String)

                The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.

              • WaitUntil — (String)

                The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.

          • RandomSplit — (map)

            The settings for a random split activity. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify.

            • Branches — (Array<map>)

              The paths for the activity, including the percentage of participants to enter each path and the activity to perform for each path.

              • NextActivity — (String)

                The unique identifier for the next activity to perform, after completing the activity for the path.

              • Percentage — (Integer)

                The percentage of participants to send down the activity path.

          • Wait — (map)

            The settings for a wait activity. This type of activity waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.

            • NextActivity — (String)

              The unique identifier for the next activity to perform, after performing the wait activity.

            • WaitTime — (map)

              The amount of time to wait or the date and time when the activity moves participants to the next activity in the journey.

              • WaitFor — (String)

                The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.

              • WaitUntil — (String)

                The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.

        • ApplicationIdrequired — (String)

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

        • CreationDate — (String)

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

        • Idrequired — (String)

          The unique identifier for the journey.

        • LastModifiedDate — (String)

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

        • Limits — (map)

          The messaging and entry limits for the journey.

          • DailyCap — (Integer)

            The maximum number of messages that the journey can send to a single participant during a 24-hour period. The maximum value is 100.

          • EndpointReentryCap — (Integer)

            The maximum number of times that a participant can enter the journey. The maximum value is 100. To allow participants to enter the journey an unlimited number of times, set this value to 0.

          • MessagesPerSecond — (Integer)

            The maximum number of messages that the journey can send each second.

        • LocalTime — (Boolean)

          Specifies whether the journey's scheduled start and end times use each participant's local time. If this value is true, the schedule uses each participant's local time.

        • Namerequired — (String)

          The name of the journey.

        • QuietTime — (map)

          The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:

          • The EndpointDemographic.Timezone property of the endpoint for the participant is set to a valid value.

          • The current time in the participant's time zone is later than or equal to the time specified by the QuietTime.Start property for the journey.

          • The current time in the participant's time zone is earlier than or equal to the time specified by the QuietTime.End property for the journey.

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

          • End — (String)

            The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

          • Start — (String)

            The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

        • RefreshFrequency — (String)

          The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.

        • Schedule — (map)

          The schedule settings for the journey.

          • EndTime — (Date)

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

          • StartTime — (Date)

            The scheduled time, in ISO 8601 format, when the journey began or will begin.

          • Timezone — (String)

            The starting UTC offset for the journey schedule, if the value of the journey's LocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+08:45, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+12:45, UTC+13, UTC+13:45, UTC-02, UTC-02:30, UTC-03, UTC-03:30, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-09:30, UTC-10, and UTC-11.

        • StartActivity — (String)

          The unique identifier for the first activity in the journey.

        • StartCondition — (map)

          The segment that defines which users are participants in the journey.

          • Description — (String)

            The custom description of the condition.

          • SegmentStartCondition — (map)

            The segment that's associated with the first activity in the journey. This segment determines which users are participants in the journey.

            • SegmentIdrequired — (String)

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

        • State — (String)

          The current status of the journey. Possible values are:

          • DRAFT - The journey is being developed and hasn't been published yet.

          • ACTIVE - The journey has been developed and published. Depending on the journey's schedule, the journey may currently be running or scheduled to start running at a later time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.

          • COMPLETED - The journey has been published and has finished running. All participants have entered the journey and no participants are waiting to complete the journey or any activities in the journey.

          • CANCELLED - The journey has been stopped. If a journey's status is CANCELLED, you can't add, change, or remove activities or segment settings from the journey.

          • CLOSED - The journey has been published and has started running. It may have also passed its scheduled end time, or passed its scheduled start time and a refresh frequency hasn't been specified for it. If a journey's status is CLOSED, you can't add participants to it, and no existing participants can enter the journey for the first time. However, any existing participants who are currently waiting to start an activity may resume the journey.

          Possible values include:
          • "DRAFT"
          • "ACTIVE"
          • "COMPLETED"
          • "CANCELLED"
          • "CLOSED"
        • tags — (map<String>)

          A string-to-string map of key-value pairs that identifies the tags that are associated with the journey. Each tag consists of a required tag key and an associated tag value.

Returns:

  • (AWS.Request)

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

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

Creates a message template that you can use in messages that are sent through a push notification channel.

Service Reference:

Examples:

Calling the createPushTemplate operation

var params = {
  PushNotificationTemplateRequest: { /* required */
    ADM: {
      Action: OPEN_APP | DEEP_LINK | URL,
      Body: 'STRING_VALUE',
      ImageIconUrl: 'STRING_VALUE',
      ImageUrl: 'STRING_VALUE',
      RawContent: 'STRING_VALUE',
      SmallImageIconUrl: 'STRING_VALUE',
      Sound: 'STRING_VALUE',
      Title: 'STRING_VALUE',
      Url: 'STRING_VALUE'
    },
    APNS: {
      Action: OPEN_APP | DEEP_LINK | URL,
      Body: 'STRING_VALUE',
      MediaUrl: 'STRING_VALUE',
      RawContent: 'STRING_VALUE',
      Sound: 'STRING_VALUE',
      Title: 'STRING_VALUE',
      Url: 'STRING_VALUE'
    },
    Baidu: {
      Action: OPEN_APP | DEEP_LINK | URL,
      Body: 'STRING_VALUE',
      ImageIconUrl: 'STRING_VALUE',
      ImageUrl: 'STRING_VALUE',
      RawContent: 'STRING_VALUE',
      SmallImageIconUrl: 'STRING_VALUE',
      Sound: 'STRING_VALUE',
      Title: 'STRING_VALUE',
      Url: 'STRING_VALUE'
    },
    Default: {
      Action: OPEN_APP | DEEP_LINK | URL,
      Body: 'STRING_VALUE',
      Sound: 'STRING_VALUE',
      Title: 'STRING_VALUE',
      Url: 'STRING_VALUE'
    },
    DefaultSubstitutions: 'STRING_VALUE',
    GCM: {
      Action: OPEN_APP | DEEP_LINK | URL,
      Body: 'STRING_VALUE',
      ImageIconUrl: 'STRING_VALUE',
      ImageUrl: 'STRING_VALUE',
      RawContent: 'STRING_VALUE',
      SmallImageIconUrl: 'STRING_VALUE',
      Sound: 'STRING_VALUE',
      Title: 'STRING_VALUE',
      Url: 'STRING_VALUE'
    },
    TemplateDescription: 'STRING_VALUE',
    tags: {
      '<__string>': 'STRING_VALUE',
      /* '<__string>': ... */
    }
  },
  TemplateName: 'STRING_VALUE' /* required */
};
pinpoint.createPushTemplate(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: {})
    • PushNotificationTemplateRequest — (map)

      Creates a message template that you can use in messages that are sent through a push notification channel.

      • ADM — (map)

        The message template to use for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

        • Action — (String)

          The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:

          • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

          • DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.

          • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

          Possible values include:
          • "OPEN_APP"
          • "DEEP_LINK"
          • "URL"
        • Body — (String)

          The message body to use in a push notification that's based on the message template.

        • ImageIconUrl — (String)

          The URL of the large icon image to display in the content view of a push notification that's based on the message template.

        • ImageUrl — (String)

          The URL of an image to display in a push notification that's based on the message template.

        • RawContent — (String)

          The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template. If specified, this value overrides all other content for the message template.

        • SmallImageIconUrl — (String)

          The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.

        • Sound — (String)

          The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

        • Title — (String)

          The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.

        • Url — (String)

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

      • APNS — (map)

        The message template to use for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

        • Action — (String)

          The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:

          • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

          • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform.

          • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

          Possible values include:
          • "OPEN_APP"
          • "DEEP_LINK"
          • "URL"
        • Body — (String)

          The message body to use in push notifications that are based on the message template.

        • MediaUrl — (String)

          The URL of an image or video to display in push notifications that are based on the message template.

        • RawContent — (String)

          The raw, JSON-formatted string to use as the payload for push notifications that are based on the message template. If specified, this value overrides all other content for the message template.

        • Sound — (String)

          The key for the sound to play when the recipient receives a push notification that's based on the message template. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.

        • Title — (String)

          The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device.

        • Url — (String)

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

      • Baidu — (map)

        The message template to use for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

        • Action — (String)

          The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:

          • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

          • DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.

          • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

          Possible values include:
          • "OPEN_APP"
          • "DEEP_LINK"
          • "URL"
        • Body — (String)

          The message body to use in a push notification that's based on the message template.

        • ImageIconUrl — (String)

          The URL of the large icon image to display in the content view of a push notification that's based on the message template.

        • ImageUrl — (String)

          The URL of an image to display in a push notification that's based on the message template.

        • RawContent — (String)

          The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template. If specified, this value overrides all other content for the message template.

        • SmallImageIconUrl — (String)

          The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.

        • Sound — (String)

          The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

        • Title — (String)

          The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.

        • Url — (String)

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

      • Default — (map)

        The default message template to use for push notification channels.

        • Action — (String)

          The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:

          • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

          • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.

          • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

          Possible values include:
          • "OPEN_APP"
          • "DEEP_LINK"
          • "URL"
        • Body — (String)

          The message body to use in push notifications that are based on the message template.

        • Sound — (String)

          The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

          For an iOS platform, this value is the key for the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.

        • Title — (String)

          The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device.

        • Url — (String)

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

      • DefaultSubstitutions — (String)

        A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.

      • GCM — (map)

        The message template to use for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

        • Action — (String)

          The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:

          • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

          • DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.

          • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

          Possible values include:
          • "OPEN_APP"
          • "DEEP_LINK"
          • "URL"
        • Body — (String)

          The message body to use in a push notification that's based on the message template.

        • ImageIconUrl — (String)

          The URL of the large icon image to display in the content view of a push notification that's based on the message template.

        • ImageUrl — (String)

          The URL of an image to display in a push notification that's based on the message template.

        • RawContent — (String)

          The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template. If specified, this value overrides all other content for the message template.

        • SmallImageIconUrl — (String)

          The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.

        • Sound — (String)

          The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

        • Title — (String)

          The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.

        • Url — (String)

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

      • tags — (map<String>)

        A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.

      • TemplateDescription — (String)

        A custom description of the message template.

    • TemplateName — (String)

      The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

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:

      • CreateTemplateMessageBody — (map)

        Provides information about a request to create a message template.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the message template that was created.

        • Message — (String)

          The message that's returned from the API for the request to create the message template.

        • RequestID — (String)

          The unique identifier for the request to create the message template.

Returns:

  • (AWS.Request)

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

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

Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.

Service Reference:

Examples:

Calling the createSegment operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  WriteSegmentRequest: { /* required */
    Dimensions: {
      Attributes: {
        '<__string>': {
          Values: [ /* required */
            'STRING_VALUE',
            /* more items */
          ],
          AttributeType: INCLUSIVE | EXCLUSIVE
        },
        /* '<__string>': ... */
      },
      Behavior: {
        Recency: {
          Duration: HR_24 | DAY_7 | DAY_14 | DAY_30, /* required */
          RecencyType: ACTIVE | INACTIVE /* required */
        }
      },
      Demographic: {
        AppVersion: {
          Values: [ /* required */
            'STRING_VALUE',
            /* more items */
          ],
          DimensionType: INCLUSIVE | EXCLUSIVE
        },
        Channel: {
          Values: [ /* required */
            'STRING_VALUE',
            /* more items */
          ],
          DimensionType: INCLUSIVE | EXCLUSIVE
        },
        DeviceType: {
          Values: [ /* required */
            'STRING_VALUE',
            /* more items */
          ],
          DimensionType: INCLUSIVE | EXCLUSIVE
        },
        Make: {
          Values: [ /* required */
            'STRING_VALUE',
            /* more items */
          ],
          DimensionType: INCLUSIVE | EXCLUSIVE
        },
        Model: {
          Values: [ /* required */
            'STRING_VALUE',
            /* more items */
          ],
          DimensionType: INCLUSIVE | EXCLUSIVE
        },
        Platform: {
          Values: [ /* required */
            'STRING_VALUE',
            /* more items */
          ],
          DimensionType: INCLUSIVE | EXCLUSIVE
        }
      },
      Location: {
        Country: {
          Values: [ /* required */
            'STRING_VALUE',
            /* more items */
          ],
          DimensionType: INCLUSIVE | EXCLUSIVE
        },
        GPSPoint: {
          Coordinates: { /* required */
            Latitude: 'NUMBER_VALUE', /* required */
            Longitude: 'NUMBER_VALUE' /* required */
          },
          RangeInKilometers: 'NUMBER_VALUE'
        }
      },
      Metrics: {
        '<__string>': {
          ComparisonOperator: 'STRING_VALUE', /* required */
          Value: 'NUMBER_VALUE' /* required */
        },
        /* '<__string>': ... */
      },
      UserAttributes: {
        '<__string>': {
          Values: [ /* required */
            'STRING_VALUE',
            /* more items */
          ],
          AttributeType: INCLUSIVE | EXCLUSIVE
        },
        /* '<__string>': ... */
      }
    },
    Name: 'STRING_VALUE',
    SegmentGroups: {
      Groups: [
        {
          Dimensions: [
            {
              Attributes: {
                '<__string>': {
                  Values: [ /* required */
                    'STRING_VALUE',
                    /* more items */
                  ],
                  AttributeType: INCLUSIVE | EXCLUSIVE
                },
                /* '<__string>': ... */
              },
              Behavior: {
                Recency: {
                  Duration: HR_24 | DAY_7 | DAY_14 | DAY_30, /* required */
                  RecencyType: ACTIVE | INACTIVE /* required */
                }
              },
              Demographic: {
                AppVersion: {
                  Values: [ /* required */
                    'STRING_VALUE',
                    /* more items */
                  ],
                  DimensionType: INCLUSIVE | EXCLUSIVE
                },
                Channel: {
                  Values: [ /* required */
                    'STRING_VALUE',
                    /* more items */
                  ],
                  DimensionType: INCLUSIVE | EXCLUSIVE
                },
                DeviceType: {
                  Values: [ /* required */
                    'STRING_VALUE',
                    /* more items */
                  ],
                  DimensionType: INCLUSIVE | EXCLUSIVE
                },
                Make: {
                  Values: [ /* required */
                    'STRING_VALUE',
                    /* more items */
                  ],
                  DimensionType: INCLUSIVE | EXCLUSIVE
                },
                Model: {
                  Values: [ /* required */
                    'STRING_VALUE',
                    /* more items */
                  ],
                  DimensionType: INCLUSIVE | EXCLUSIVE
                },
                Platform: {
                  Values: [ /* required */
                    'STRING_VALUE',
                    /* more items */
                  ],
                  DimensionType: INCLUSIVE | EXCLUSIVE
                }
              },
              Location: {
                Country: {
                  Values: [ /* required */
                    'STRING_VALUE',
                    /* more items */
                  ],
                  DimensionType: INCLUSIVE | EXCLUSIVE
                },
                GPSPoint: {
                  Coordinates: { /* required */
                    Latitude: 'NUMBER_VALUE', /* required */
                    Longitude: 'NUMBER_VALUE' /* required */
                  },
                  RangeInKilometers: 'NUMBER_VALUE'
                }
              },
              Metrics: {
                '<__string>': {
                  ComparisonOperator: 'STRING_VALUE', /* required */
                  Value: 'NUMBER_VALUE' /* required */
                },
                /* '<__string>': ... */
              },
              UserAttributes: {
                '<__string>': {
                  Values: [ /* required */
                    'STRING_VALUE',
                    /* more items */
                  ],
                  AttributeType: INCLUSIVE | EXCLUSIVE
                },
                /* '<__string>': ... */
              }
            },
            /* more items */
          ],
          SourceSegments: [
            {
              Id: 'STRING_VALUE', /* required */
              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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    • WriteSegmentRequest — (map)

      Specifies the configuration, dimension, and other settings for a segment. A WriteSegmentRequest object can include a Dimensions object or a SegmentGroups object, but not both.

      • Dimensions — (map)

        The criteria that define the dimensions for the segment.

        • Attributes — (map<map>)

          One or more custom attributes to use as criteria for the segment.

          • AttributeType — (String)

            The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

            Possible values include:
            • "INCLUSIVE"
            • "EXCLUSIVE"
          • Valuesrequired — (Array<String>)

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

        • Behavior — (map)

          The behavior-based criteria, such as how recently users have used your app, for the segment.

          • Recency — (map)

            The dimension settings that are based on how recently an endpoint was active.

            • Durationrequired — (String)

              The duration to use when determining whether an endpoint is active or inactive.

              Possible values include:
              • "HR_24"
              • "DAY_7"
              • "DAY_14"
              • "DAY_30"
            • RecencyTyperequired — (String)

              The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.

              Possible values include:
              • "ACTIVE"
              • "INACTIVE"
        • Demographic — (map)

          The demographic-based criteria, such as device platform, for the segment.

          • AppVersion — (map)

            The app version criteria for the segment.

            • DimensionType — (String)

              The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

              Possible values include:
              • "INCLUSIVE"
              • "EXCLUSIVE"
            • Valuesrequired — (Array<String>)

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

          • Channel — (map)

            The channel criteria for the segment.

            • DimensionType — (String)

              The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

              Possible values include:
              • "INCLUSIVE"
              • "EXCLUSIVE"
            • Valuesrequired — (Array<String>)

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

          • DeviceType — (map)

            The device type criteria for the segment.

            • DimensionType — (String)

              The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

              Possible values include:
              • "INCLUSIVE"
              • "EXCLUSIVE"
            • Valuesrequired — (Array<String>)

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

          • Make — (map)

            The device make criteria for the segment.

            • DimensionType — (String)

              The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

              Possible values include:
              • "INCLUSIVE"
              • "EXCLUSIVE"
            • Valuesrequired — (Array<String>)

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

          • Model — (map)

            The device model criteria for the segment.

            • DimensionType — (String)

              The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

              Possible values include:
              • "INCLUSIVE"
              • "EXCLUSIVE"
            • Valuesrequired — (Array<String>)

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

          • Platform — (map)

            The device platform criteria for the segment.

            • DimensionType — (String)

              The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

              Possible values include:
              • "INCLUSIVE"
              • "EXCLUSIVE"
            • Valuesrequired — (Array<String>)

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

        • Location — (map)

          The location-based criteria, such as region or GPS coordinates, for the segment.

          • Country — (map)

            The country or region code, in ISO 3166-1 alpha-2 format, for the segment.

            • DimensionType — (String)

              The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

              Possible values include:
              • "INCLUSIVE"
              • "EXCLUSIVE"
            • Valuesrequired — (Array<String>)

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

          • GPSPoint — (map)

            The GPS location and range for the segment.

            • Coordinatesrequired — (map)

              The GPS coordinates to measure distance from.

              • Latituderequired — (Float)

                The latitude coordinate of the location.

              • Longituderequired — (Float)

                The longitude coordinate of the location.

            • RangeInKilometers — (Float)

              The range, in kilometers, from the GPS coordinates.

        • Metrics — (map<map>)

          One or more custom metrics to use as criteria for the segment.

          • ComparisonOperatorrequired — (String)

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

          • Valuerequired — (Float)

            The value to compare.

        • UserAttributes — (map<map>)

          One or more custom user attributes to use as criteria for the segment.

          • AttributeType — (String)

            The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

            Possible values include:
            • "INCLUSIVE"
            • "EXCLUSIVE"
          • Valuesrequired — (Array<String>)

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

      • Name — (String)

        The name of the segment.

      • SegmentGroups — (map)

        The segment group to use and the dimensions to apply to the group's base segments in order to build the segment. A segment group can consist of zero or more base segments. Your request can include only one segment group.

        • Groups — (Array<map>)

          An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.

          • Dimensions — (Array<map>)

            An array that defines the dimensions for the segment.

            • Attributes — (map<map>)

              One or more custom attributes to use as criteria for the segment.

              • AttributeType — (String)

                The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Valuesrequired — (Array<String>)

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

            • Behavior — (map)

              The behavior-based criteria, such as how recently users have used your app, for the segment.

              • Recency — (map)

                The dimension settings that are based on how recently an endpoint was active.

                • Durationrequired — (String)

                  The duration to use when determining whether an endpoint is active or inactive.

                  Possible values include:
                  • "HR_24"
                  • "DAY_7"
                  • "DAY_14"
                  • "DAY_30"
                • RecencyTyperequired — (String)

                  The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.

                  Possible values include:
                  • "ACTIVE"
                  • "INACTIVE"
            • Demographic — (map)

              The demographic-based criteria, such as device platform, for the segment.

              • AppVersion — (map)

                The app version criteria for the segment.

                • DimensionType — (String)

                  The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                  Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Valuesrequired — (Array<String>)

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

              • Channel — (map)

                The channel criteria for the segment.

                • DimensionType — (String)

                  The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                  Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Valuesrequired — (Array<String>)

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

              • DeviceType — (map)

                The device type criteria for the segment.

                • DimensionType — (String)

                  The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                  Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Valuesrequired — (Array<String>)

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

              • Make — (map)

                The device make criteria for the segment.

                • DimensionType — (String)

                  The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                  Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Valuesrequired — (Array<String>)

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

              • Model — (map)

                The device model criteria for the segment.

                • DimensionType — (String)

                  The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                  Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Valuesrequired — (Array<String>)

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

              • Platform — (map)

                The device platform criteria for the segment.

                • DimensionType — (String)

                  The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                  Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Valuesrequired — (Array<String>)

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

            • Location — (map)

              The location-based criteria, such as region or GPS coordinates, for the segment.

              • Country — (map)

                The country or region code, in ISO 3166-1 alpha-2 format, for the segment.

                • DimensionType — (String)

                  The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                  Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Valuesrequired — (Array<String>)

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

              • GPSPoint — (map)

                The GPS location and range for the segment.

                • Coordinatesrequired — (map)

                  The GPS coordinates to measure distance from.

                  • Latituderequired — (Float)

                    The latitude coordinate of the location.

                  • Longituderequired — (Float)

                    The longitude coordinate of the location.

                • RangeInKilometers — (Float)

                  The range, in kilometers, from the GPS coordinates.

            • Metrics — (map<map>)

              One or more custom metrics to use as criteria for the segment.

              • ComparisonOperatorrequired — (String)

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

              • Valuerequired — (Float)

                The value to compare.

            • UserAttributes — (map<map>)

              One or more custom user attributes to use as criteria for the segment.

              • AttributeType — (String)

                The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Valuesrequired — (Array<String>)

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

          • SourceSegments — (Array<map>)

            The base segment to build the segment on. A base segment, also referred to as a source segment, defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify.

            You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size of the imported segment without any filters applied to it.

            • Idrequired — (String)

              The unique identifier for the segment.

            • Version — (Integer)

              The version number of the segment.

          • SourceType — (String)

            Specifies how to handle multiple base segments for the segment. For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.

            Possible values include:
            • "ALL"
            • "ANY"
            • "NONE"
          • Type — (String)

            Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.

            Possible values include:
            • "ALL"
            • "ANY"
            • "NONE"
        • Include — (String)

          Specifies how to handle multiple segment groups for the segment. For example, if the segment includes three segment groups, whether the resulting segment includes endpoints that match all, any, or none of the segment groups.

          Possible values include:
          • "ALL"
          • "ANY"
          • "NONE"
      • tags — (map<String>)

        A string-to-string map of key-value pairs that defines the tags to associate with the segment. Each tag consists of a required tag key and an associated tag value.

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)

        Provides information about the configuration, dimension, and other settings for a segment.

        • ApplicationIdrequired — (String)

          The unique identifier for the application that the segment is associated with.

        • Arnrequired — (String)

          The Amazon Resource Name (ARN) of the segment.

        • CreationDaterequired — (String)

          The date and time when the segment was created.

        • Dimensions — (map)

          The dimension settings for the segment.

          • Attributes — (map<map>)

            One or more custom attributes to use as criteria for the segment.

            • AttributeType — (String)

              The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

              Possible values include:
              • "INCLUSIVE"
              • "EXCLUSIVE"
            • Valuesrequired — (Array<String>)

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

          • Behavior — (map)

            The behavior-based criteria, such as how recently users have used your app, for the segment.

            • Recency — (map)

              The dimension settings that are based on how recently an endpoint was active.

              • Durationrequired — (String)

                The duration to use when determining whether an endpoint is active or inactive.

                Possible values include:
                • "HR_24"
                • "DAY_7"
                • "DAY_14"
                • "DAY_30"
              • RecencyTyperequired — (String)

                The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.

                Possible values include:
                • "ACTIVE"
                • "INACTIVE"
          • Demographic — (map)

            The demographic-based criteria, such as device platform, for the segment.

            • AppVersion — (map)

              The app version criteria for the segment.

              • DimensionType — (String)

                The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Valuesrequired — (Array<String>)

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

            • Channel — (map)

              The channel criteria for the segment.

              • DimensionType — (String)

                The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Valuesrequired — (Array<String>)

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

            • DeviceType — (map)

              The device type criteria for the segment.

              • DimensionType — (String)

                The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Valuesrequired — (Array<String>)

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

            • Make — (map)

              The device make criteria for the segment.

              • DimensionType — (String)

                The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Valuesrequired — (Array<String>)

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

            • Model — (map)

              The device model criteria for the segment.

              • DimensionType — (String)

                The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Valuesrequired — (Array<String>)

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

            • Platform — (map)

              The device platform criteria for the segment.

              • DimensionType — (String)

                The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Valuesrequired — (Array<String>)

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

          • Location — (map)

            The location-based criteria, such as region or GPS coordinates, for the segment.

            • Country — (map)

              The country or region code, in ISO 3166-1 alpha-2 format, for the segment.

              • DimensionType — (String)

                The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Valuesrequired — (Array<String>)

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

            • GPSPoint — (map)

              The GPS location and range for the segment.

              • Coordinatesrequired — (map)

                The GPS coordinates to measure distance from.

                • Latituderequired — (Float)

                  The latitude coordinate of the location.

                • Longituderequired — (Float)

                  The longitude coordinate of the location.

              • RangeInKilometers — (Float)

                The range, in kilometers, from the GPS coordinates.

          • Metrics — (map<map>)

            One or more custom metrics to use as criteria for the segment.

            • ComparisonOperatorrequired — (String)

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

            • Valuerequired — (Float)

              The value to compare.

          • UserAttributes — (map<map>)

            One or more custom user attributes to use as criteria for the segment.

            • AttributeType — (String)

              The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

              Possible values include:
              • "INCLUSIVE"
              • "EXCLUSIVE"
            • Valuesrequired — (Array<String>)

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

        • Idrequired — (String)

          The unique identifier for the segment.

        • ImportDefinition — (map)

          The settings for the import job that's associated with the segment.

          • ChannelCounts — (map<Integer>)

            The number of channel types in the endpoint definitions that were imported to create the segment.

          • ExternalIdrequired — (String)

            (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.

          • Formatrequired — (String)

            The format of the files that were imported to create the segment. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.

            Possible values include:
            • "CSV"
            • "JSON"
          • RoleArnrequired — (String)

            The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.

          • S3Urlrequired — (String)

            The URL of the Amazon Simple Storage Service (Amazon S3) bucket that the endpoint definitions were imported from to create the segment.

          • Sizerequired — (Integer)

            The number of endpoint definitions that were imported successfully to create the segment.

        • LastModifiedDate — (String)

          The date and time when the segment was last modified.

        • Name — (String)

          The name of the segment.

        • SegmentGroups — (map)

          A list of one or more segment groups that apply to the segment. Each segment group consists of zero or more base segments and the dimensions that are applied to those base segments.

          • Groups — (Array<map>)

            An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.

            • Dimensions — (Array<map>)

              An array that defines the dimensions for the segment.

              • Attributes — (map<map>)

                One or more custom attributes to use as criteria for the segment.

                • AttributeType — (String)

                  The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                  Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Valuesrequired — (Array<String>)

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

              • Behavior — (map)

                The behavior-based criteria, such as how recently users have used your app, for the segment.

                • Recency — (map)

                  The dimension settings that are based on how recently an endpoint was active.

                  • Durationrequired — (String)

                    The duration to use when determining whether an endpoint is active or inactive.

                    Possible values include:
                    • "HR_24"
                    • "DAY_7"
                    • "DAY_14"
                    • "DAY_30"
                  • RecencyTyperequired — (String)

                    The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.

                    Possible values include:
                    • "ACTIVE"
                    • "INACTIVE"
              • Demographic — (map)

                The demographic-based criteria, such as device platform, for the segment.

                • AppVersion — (map)

                  The app version criteria for the segment.

                  • DimensionType — (String)

                    The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                    Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Valuesrequired — (Array<String>)

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

                • Channel — (map)

                  The channel criteria for the segment.

                  • DimensionType — (String)

                    The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                    Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Valuesrequired — (Array<String>)

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

                • DeviceType — (map)

                  The device type criteria for the segment.

                  • DimensionType — (String)

                    The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                    Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Valuesrequired — (Array<String>)

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

                • Make — (map)

                  The device make criteria for the segment.

                  • DimensionType — (String)

                    The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                    Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Valuesrequired — (Array<String>)

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

                • Model — (map)

                  The device model criteria for the segment.

                  • DimensionType — (String)

                    The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                    Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Valuesrequired — (Array<String>)

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

                • Platform — (map)

                  The device platform criteria for the segment.

                  • DimensionType — (String)

                    The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                    Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Valuesrequired — (Array<String>)

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

              • Location — (map)

                The location-based criteria, such as region or GPS coordinates, for the segment.

                • Country — (map)

                  The country or region code, in ISO 3166-1 alpha-2 format, for the segment.

                  • DimensionType — (String)

                    The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                    Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Valuesrequired — (Array<String>)

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

                • GPSPoint — (map)

                  The GPS location and range for the segment.

                  • Coordinatesrequired — (map)

                    The GPS coordinates to measure distance from.

                    • Latituderequired — (Float)

                      The latitude coordinate of the location.

                    • Longituderequired — (Float)

                      The longitude coordinate of the location.

                  • RangeInKilometers — (Float)

                    The range, in kilometers, from the GPS coordinates.

              • Metrics — (map<map>)

                One or more custom metrics to use as criteria for the segment.

                • ComparisonOperatorrequired — (String)

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

                • Valuerequired — (Float)

                  The value to compare.

              • UserAttributes — (map<map>)

                One or more custom user attributes to use as criteria for the segment.

                • AttributeType — (String)

                  The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                  Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Valuesrequired — (Array<String>)

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

            • SourceSegments — (Array<map>)

              The base segment to build the segment on. A base segment, also referred to as a source segment, defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify.

              You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size of the imported segment without any filters applied to it.

              • Idrequired — (String)

                The unique identifier for the segment.

              • Version — (Integer)

                The version number of the segment.

            • SourceType — (String)

              Specifies how to handle multiple base segments for the segment. For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.

              Possible values include:
              • "ALL"
              • "ANY"
              • "NONE"
            • Type — (String)

              Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.

              Possible values include:
              • "ALL"
              • "ANY"
              • "NONE"
          • Include — (String)

            Specifies how to handle multiple segment groups for the segment. For example, if the segment includes three segment groups, whether the resulting segment includes endpoints that match all, any, or none of the segment groups.

            Possible values include:
            • "ALL"
            • "ANY"
            • "NONE"
        • SegmentTyperequired — (String)

          The segment type. Valid values are:

          • DIMENSIONAL - A dynamic segment, which is a segment that uses selection criteria that you specify and is based on endpoint data that's reported by your app. Dynamic segments can change over time.

          • IMPORT - A static segment, which is a segment that uses selection criteria that you specify and is based on endpoint definitions that you import from a file. Imported segments are static; they don't change over time.

          Possible values include:
          • "DIMENSIONAL"
          • "IMPORT"
        • tags — (map<String>)

          A string-to-string map of key-value pairs that identifies the tags that are associated with the segment. Each tag consists of a required tag key and an associated tag value.

        • Version — (Integer)

          The version number of the segment.

Returns:

  • (AWS.Request)

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

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

Creates a message template that you can use in messages that are sent through the SMS channel.

Service Reference:

Examples:

Calling the createSmsTemplate operation

var params = {
  SMSTemplateRequest: { /* required */
    Body: 'STRING_VALUE',
    DefaultSubstitutions: 'STRING_VALUE',
    TemplateDescription: 'STRING_VALUE',
    tags: {
      '<__string>': 'STRING_VALUE',
      /* '<__string>': ... */
    }
  },
  TemplateName: 'STRING_VALUE' /* required */
};
pinpoint.createSmsTemplate(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: {})
    • SMSTemplateRequest — (map)

      Creates a message template that you can use in messages that are sent through the SMS channel.

      • Body — (String)

        The message body to use in text messages that are based on the message template.

      • DefaultSubstitutions — (String)

        A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.

      • tags — (map<String>)

        A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.

      • TemplateDescription — (String)

        A custom description of the message template.

    • TemplateName — (String)

      The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

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:

      • CreateTemplateMessageBody — (map)

        Provides information about a request to create a message template.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the message template that was created.

        • Message — (String)

          The message that's returned from the API for the request to create the message template.

        • RequestID — (String)

          The unique identifier for the request to create the message template.

Returns:

  • (AWS.Request)

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

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

Creates a message template that you can use in messages that are sent through the voice channel.

Service Reference:

Examples:

Calling the createVoiceTemplate operation

var params = {
  TemplateName: 'STRING_VALUE', /* required */
  VoiceTemplateRequest: { /* required */
    Body: 'STRING_VALUE',
    DefaultSubstitutions: 'STRING_VALUE',
    LanguageCode: 'STRING_VALUE',
    TemplateDescription: 'STRING_VALUE',
    VoiceId: 'STRING_VALUE',
    tags: {
      '<__string>': 'STRING_VALUE',
      /* '<__string>': ... */
    }
  }
};
pinpoint.createVoiceTemplate(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: {})
    • TemplateName — (String)

      The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    • VoiceTemplateRequest — (map)

      Specifies the content and settings for a message template that can be used in messages that are sent through the voice channel.

      • Body — (String)

        The text of the script to use in messages that are based on the message template, in plain text format.

      • DefaultSubstitutions — (String)

        A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.

      • LanguageCode — (String)

        The code for the language to use when synthesizing the text of the script in messages that are based on the message template. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide.

      • tags — (map<String>)

        A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.

      • TemplateDescription — (String)

        A custom description of the message template.

      • VoiceId — (String)

        The name of the voice to use when delivering messages that are based on the message template. For a list of supported voices, see the Amazon Polly Developer Guide.

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:

      • CreateTemplateMessageBody — (map)

        Provides information about a request to create a message template.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the message template that was created.

        • Message — (String)

          The message that's returned from the API for the request to create the message template.

        • RequestID — (String)

          The unique identifier for the request to create the message template.

Returns:

  • (AWS.Request)

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

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

Disables the ADM channel for an application and deletes any existing settings for the 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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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)

        Provides information about the status and settings of the ADM (Amazon Device Messaging) channel for an application.

        • ApplicationId — (String)

          The unique identifier for the application that the ADM channel applies to.

        • CreationDate — (String)

          The date and time when the ADM channel was enabled.

        • Enabled — (Boolean)

          Specifies whether the ADM channel is enabled for the application.

        • HasCredential — (Boolean)

          (Not used) This property is retained only for backward compatibility.

        • Id — (String)

          (Deprecated) An identifier for the ADM channel. This property is retained only for backward compatibility.

        • IsArchived — (Boolean)

          Specifies whether the ADM channel is archived.

        • LastModifiedBy — (String)

          The user who last modified the ADM channel.

        • LastModifiedDate — (String)

          The date and time when the ADM channel was last modified.

        • Platformrequired — (String)

          The type of messaging or notification platform for the channel. For the ADM channel, this value is ADM.

        • Version — (Integer)

          The current version of the ADM channel.

Returns:

  • (AWS.Request)

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

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

Disables the APNs channel for an application and deletes any existing settings for the channel.

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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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)

        Provides information about the status and settings of the APNs (Apple Push Notification service) channel for an application.

        • ApplicationId — (String)

          The unique identifier for the application that the APNs channel applies to.

        • CreationDate — (String)

          The date and time when the APNs channel was enabled.

        • DefaultAuthenticationMethod — (String)

          The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate.

        • Enabled — (Boolean)

          Specifies whether the APNs channel is enabled for the application.

        • HasCredential — (Boolean)

          (Not used) This property is retained only for backward compatibility.

        • HasTokenKey — (Boolean)

          Specifies whether the APNs channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.

        • Id — (String)

          (Deprecated) An identifier for the APNs channel. This property is retained only for backward compatibility.

        • IsArchived — (Boolean)

          Specifies whether the APNs channel is archived.

        • LastModifiedBy — (String)

          The user who last modified the APNs channel.

        • LastModifiedDate — (String)

          The date and time when the APNs channel was last modified.

        • Platformrequired — (String)

          The type of messaging or notification platform for the channel. For the APNs channel, this value is APNS.

        • Version — (Integer)

          The current version of the APNs channel.

Returns:

  • (AWS.Request)

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

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

Disables the APNs sandbox channel for an application and deletes any existing settings for the 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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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)

        Provides information about the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.

        • ApplicationId — (String)

          The unique identifier for the application that the APNs sandbox channel applies to.

        • CreationDate — (String)

          The date and time when the APNs sandbox channel was enabled.

        • DefaultAuthenticationMethod — (String)

          The default authentication method that Amazon Pinpoint uses to authenticate with the APNs sandbox environment for this channel, key or certificate.

        • Enabled — (Boolean)

          Specifies whether the APNs sandbox channel is enabled for the application.

        • HasCredential — (Boolean)

          (Not used) This property is retained only for backward compatibility.

        • HasTokenKey — (Boolean)

          Specifies whether the APNs sandbox channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.

        • Id — (String)

          (Deprecated) An identifier for the APNs sandbox channel. This property is retained only for backward compatibility.

        • IsArchived — (Boolean)

          Specifies whether the APNs sandbox channel is archived.

        • LastModifiedBy — (String)

          The user who last modified the APNs sandbox channel.

        • LastModifiedDate — (String)

          The date and time when the APNs sandbox channel was last modified.

        • Platformrequired — (String)

          The type of messaging or notification platform for the channel. For the APNs sandbox channel, this value is APNS_SANDBOX.

        • Version — (Integer)

          The current version of the APNs sandbox channel.

Returns:

  • (AWS.Request)

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

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

Disables the APNs VoIP channel for an application and deletes any existing settings for the 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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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)

        Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.

        • ApplicationId — (String)

          The unique identifier for the application that the APNs VoIP channel applies to.

        • CreationDate — (String)

          The date and time when the APNs VoIP channel was enabled.

        • DefaultAuthenticationMethod — (String)

          The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate.

        • Enabled — (Boolean)

          Specifies whether the APNs VoIP channel is enabled for the application.

        • HasCredential — (Boolean)

          (Not used) This property is retained only for backward compatibility.

        • HasTokenKey — (Boolean)

          Specifies whether the APNs VoIP channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.

        • Id — (String)

          (Deprecated) An identifier for the APNs VoIP channel. This property is retained only for backward compatibility.

        • IsArchived — (Boolean)

          Specifies whether the APNs VoIP channel is archived.

        • LastModifiedBy — (String)

          The user who last modified the APNs VoIP channel.

        • LastModifiedDate — (String)

          The date and time when the APNs VoIP channel was last modified.

        • Platformrequired — (String)

          The type of messaging or notification platform for the channel. For the APNs VoIP channel, this value is APNS_VOIP.

        • Version — (Integer)

          The current version of the APNs VoIP channel.

Returns:

  • (AWS.Request)

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

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

Disables the APNs VoIP sandbox channel for an application and deletes any existing settings for the 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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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)

        Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application.

        • ApplicationId — (String)

          The unique identifier for the application that the APNs VoIP sandbox channel applies to.

        • CreationDate — (String)

          The date and time when the APNs VoIP sandbox channel was enabled.

        • DefaultAuthenticationMethod — (String)

          The default authentication method that Amazon Pinpoint uses to authenticate with the APNs sandbox environment for this channel, key or certificate.

        • Enabled — (Boolean)

          Specifies whether the APNs VoIP sandbox channel is enabled for the application.

        • HasCredential — (Boolean)

          (Not used) This property is retained only for backward compatibility.

        • HasTokenKey — (Boolean)

          Specifies whether the APNs VoIP sandbox channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.

        • Id — (String)

          (Deprecated) An identifier for the APNs VoIP sandbox channel. This property is retained only for backward compatibility.

        • IsArchived — (Boolean)

          Specifies whether the APNs VoIP sandbox channel is archived.

        • LastModifiedBy — (String)

          The user who last modified the APNs VoIP sandbox channel.

        • LastModifiedDate — (String)

          The date and time when the APNs VoIP sandbox channel was last modified.

        • Platformrequired — (String)

          The type of messaging or notification platform for the channel. For the APNs VoIP sandbox channel, this value is APNS_VOIP_SANDBOX.

        • Version — (Integer)

          The current version of the APNs VoIP sandbox channel.

Returns:

  • (AWS.Request)

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

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

Deletes an application.

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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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)

        Provides information about an application.

        • Arnrequired — (String)

          The Amazon Resource Name (ARN) of the application.

        • Idrequired — (String)

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

        • Namerequired — (String)

          The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console.

        • tags — (map<String>)

          A string-to-string map of key-value pairs that identifies the tags that are associated with the application. Each tag consists of a required tag key and an associated tag value.

Returns:

  • (AWS.Request)

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

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

Disables the Baidu channel for an application and deletes any existing settings for the 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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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)

        Provides information about the status and settings of the Baidu (Baidu Cloud Push) channel for an application.

        • ApplicationId — (String)

          The unique identifier for the application that the Baidu channel applies to.

        • CreationDate — (String)

          The date and time when the Baidu channel was enabled.

        • Credentialrequired — (String)

          The API key that you received from the Baidu Cloud Push service to communicate with the service.

        • Enabled — (Boolean)

          Specifies whether the Baidu channel is enabled for the application.

        • HasCredential — (Boolean)

          (Not used) This property is retained only for backward compatibility.

        • Id — (String)

          (Deprecated) An identifier for the Baidu channel. This property is retained only for backward compatibility.

        • IsArchived — (Boolean)

          Specifies whether the Baidu channel is archived.

        • LastModifiedBy — (String)

          The user who last modified the Baidu channel.

        • LastModifiedDate — (String)

          The date and time when the Baidu channel was last modified.

        • Platformrequired — (String)

          The type of messaging or notification platform for the channel. For the Baidu channel, this value is BAIDU.

        • Version — (Integer)

          The current version of the Baidu channel.

Returns:

  • (AWS.Request)

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

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

Deletes a campaign from an application.

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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    • CampaignId — (String)

      The unique identifier for 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)

        Provides information about the status, configuration, and other settings for a campaign.

        • AdditionalTreatments — (Array<map>)

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

          • Idrequired — (String)

            The unique identifier for the treatment.

          • MessageConfiguration — (map)

            The message configuration settings for the treatment.

            • ADMMessage — (map)

              The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.

              • Action — (String)

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

                • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

                • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

                • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

                Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • Body — (String)

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

              • ImageIconUrl — (String)

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

              • ImageSmallIconUrl — (String)

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

              • ImageUrl — (String)

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

              • JsonBody — (String)

                The JSON payload to use for a silent push notification.

              • MediaUrl — (String)

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

              • RawContent — (String)

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

              • SilentPush — (Boolean)

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

              • TimeToLive — (Integer)

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

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

              • Title — (String)

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

              • Url — (String)

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

            • APNSMessage — (map)

              The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.

              • Action — (String)

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

                • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

                • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

                • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

                Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • Body — (String)

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

              • ImageIconUrl — (String)

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

              • ImageSmallIconUrl — (String)

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

              • ImageUrl — (String)

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

              • JsonBody — (String)

                The JSON payload to use for a silent push notification.

              • MediaUrl — (String)

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

              • RawContent — (String)

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

              • SilentPush — (Boolean)

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

              • TimeToLive — (Integer)

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

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

              • Title — (String)

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

              • Url — (String)

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

            • BaiduMessage — (map)

              The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.

              • Action — (String)

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

                • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

                • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

                • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

                Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • Body — (String)

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

              • ImageIconUrl — (String)

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

              • ImageSmallIconUrl — (String)

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

              • ImageUrl — (String)

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

              • JsonBody — (String)

                The JSON payload to use for a silent push notification.

              • MediaUrl — (String)

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

              • RawContent — (String)

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

              • SilentPush — (Boolean)

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

              • TimeToLive — (Integer)

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

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

              • Title — (String)

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

              • Url — (String)

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

            • DefaultMessage — (map)

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

              • Action — (String)

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

                • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

                • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

                • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

                Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • Body — (String)

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

              • ImageIconUrl — (String)

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

              • ImageSmallIconUrl — (String)

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

              • ImageUrl — (String)

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

              • JsonBody — (String)

                The JSON payload to use for a silent push notification.

              • MediaUrl — (String)

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

              • RawContent — (String)

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

              • SilentPush — (Boolean)

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

              • TimeToLive — (Integer)

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

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

              • Title — (String)

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

              • Url — (String)

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

            • EmailMessage — (map)

              The message that the campaign sends through the email channel.

              • Body — (String)

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

              • FromAddress — (String)

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

              • HtmlBody — (String)

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

              • Titlerequired — (String)

                The subject line, or title, of the email.

            • GCMMessage — (map)

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

              • Action — (String)

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

                • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

                • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

                • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

                Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • Body — (String)

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

              • ImageIconUrl — (String)

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

              • ImageSmallIconUrl — (String)

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

              • ImageUrl — (String)

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

              • JsonBody — (String)

                The JSON payload to use for a silent push notification.

              • MediaUrl — (String)

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

              • RawContent — (String)

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

              • SilentPush — (Boolean)

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

              • TimeToLive — (Integer)

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

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

              • Title — (String)

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

              • Url — (String)

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

            • SMSMessage — (map)

              The message that the campaign sends through the SMS channel.

              • Body — (String)

                The body of the SMS message.

              • MessageType — (String)

                The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.

                Possible values include:
                • "TRANSACTIONAL"
                • "PROMOTIONAL"
              • SenderId — (String)

                The sender ID to display on recipients' devices when they receive the SMS message.

          • Schedule — (map)

            The schedule settings for the treatment.

            • EndTime — (String)

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

            • EventFilter — (map)

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

              • Dimensionsrequired — (map)

                The dimension settings of the event filter for the campaign.

                • Attributes — (map<map>)

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

                  • AttributeType — (String)

                    The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                    Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Valuesrequired — (Array<String>)

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

                • EventType — (map)

                  The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard type of event that Amazon Pinpoint generates, such as _email.delivered, or a custom event that's specific to your application.

                  • DimensionType — (String)

                    The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                    Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Valuesrequired — (Array<String>)

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

                • Metrics — (map<map>)

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

                  • ComparisonOperatorrequired — (String)

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

                  • Valuerequired — (Float)

                    The value to compare.

              • FilterTyperequired — (String)

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

                Possible values include:
                • "SYSTEM"
                • "ENDPOINT"
            • Frequency — (String)

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

              Possible values include:
              • "ONCE"
              • "HOURLY"
              • "DAILY"
              • "WEEKLY"
              • "MONTHLY"
              • "EVENT"
            • IsLocalTime — (Boolean)

              Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.

            • QuietTime — (map)

              The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:

              • The EndpointDemographic.Timezone property of the endpoint is set to a valid value.

              • The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.

              • The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.

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

              • End — (String)

                The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

              • Start — (String)

                The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

            • StartTimerequired — (String)

              The scheduled time, in ISO 8601 format, when the campaign began or will begin.

            • Timezone — (String)

              The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.

          • SizePercentrequired — (Integer)

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

          • State — (map)

            The current status of the treatment.

            • CampaignStatus — (String)

              The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED.

              Possible values include:
              • "SCHEDULED"
              • "EXECUTING"
              • "PENDING_NEXT_RUN"
              • "COMPLETED"
              • "PAUSED"
              • "DELETED"
          • TemplateConfiguration — (map)

            The message template to use for the treatment.

            • EmailTemplate — (map)

              The email template to use for the message.

              • Name — (String)

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

            • PushTemplate — (map)

              The push notification template to use for the message.

              • Name — (String)

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

            • SMSTemplate — (map)

              The SMS template to use for the message.

              • Name — (String)

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

            • VoiceTemplate — (map)

              The voice template to use for the message.

              • Name — (String)

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

          • TreatmentDescription — (String)

            The custom description of the treatment.

          • TreatmentName — (String)

            The custom name of the treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.

        • ApplicationIdrequired — (String)

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

        • Arnrequired — (String)

          The Amazon Resource Name (ARN) of the campaign.

        • CreationDaterequired — (String)

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

        • DefaultState — (map)

          The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment, to support A/B testing.

          • CampaignStatus — (String)

            The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED.

            Possible values include:
            • "SCHEDULED"
            • "EXECUTING"
            • "PENDING_NEXT_RUN"
            • "COMPLETED"
            • "PAUSED"
            • "DELETED"
        • Description — (String)

          The custom description of the campaign.

        • HoldoutPercent — (Integer)

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

        • Hook — (map)

          The settings for the AWS Lambda function to use as a code hook for the campaign.

          • LambdaFunctionName — (String)

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

          • Mode — (String)

            Specifies which Lambda mode to use when invoking the AWS Lambda function.

            Possible values include:
            • "DELIVERY"
            • "FILTER"
          • WebUrl — (String)

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

        • Idrequired — (String)

          The unique identifier for the campaign.

        • IsPaused — (Boolean)

          Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.

        • LastModifiedDaterequired — (String)

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

        • Limits — (map)

          The messaging limits for the campaign.

          • Daily — (Integer)

            The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. The maximum value is 100.

          • MaximumDuration — (Integer)

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

          • MessagesPerSecond — (Integer)

            The maximum number of messages that a campaign can send each second. The minimum value is 50. The maximum value is 20,000.

          • Total — (Integer)

            The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. The maximum value is 100.

        • MessageConfiguration — (map)

          The message configuration settings for the campaign.

          • ADMMessage — (map)

            The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.

            • Action — (String)

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

              • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

              • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

              • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

              Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • Body — (String)

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

            • ImageIconUrl — (String)

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

            • ImageSmallIconUrl — (String)

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

            • ImageUrl — (String)

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

            • JsonBody — (String)

              The JSON payload to use for a silent push notification.

            • MediaUrl — (String)

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

            • RawContent — (String)

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

            • SilentPush — (Boolean)

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

            • TimeToLive — (Integer)

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

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

            • Title — (String)

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

            • Url — (String)

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

          • APNSMessage — (map)

            The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.

            • Action — (String)

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

              • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

              • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

              • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

              Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • Body — (String)

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

            • ImageIconUrl — (String)

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

            • ImageSmallIconUrl — (String)

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

            • ImageUrl — (String)

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

            • JsonBody — (String)

              The JSON payload to use for a silent push notification.

            • MediaUrl — (String)

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

            • RawContent — (String)

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

            • SilentPush — (Boolean)

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

            • TimeToLive — (Integer)

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

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

            • Title — (String)

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

            • Url — (String)

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

          • BaiduMessage — (map)

            The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.

            • Action — (String)

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

              • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

              • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

              • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

              Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • Body — (String)

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

            • ImageIconUrl — (String)

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

            • ImageSmallIconUrl — (String)

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

            • ImageUrl — (String)

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

            • JsonBody — (String)

              The JSON payload to use for a silent push notification.

            • MediaUrl — (String)

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

            • RawContent — (String)

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

            • SilentPush — (Boolean)

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

            • TimeToLive — (Integer)

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

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

            • Title — (String)

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

            • Url — (String)

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

          • DefaultMessage — (map)

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

            • Action — (String)

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

              • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

              • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

              • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

              Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • Body — (String)

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

            • ImageIconUrl — (String)

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

            • ImageSmallIconUrl — (String)

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

            • ImageUrl — (String)

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

            • JsonBody — (String)

              The JSON payload to use for a silent push notification.

            • MediaUrl — (String)

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

            • RawContent — (String)

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

            • SilentPush — (Boolean)

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

            • TimeToLive — (Integer)

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

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

            • Title — (String)

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

            • Url — (String)

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

          • EmailMessage — (map)

            The message that the campaign sends through the email channel.

            • Body — (String)

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

            • FromAddress — (String)

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

            • HtmlBody — (String)

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

            • Titlerequired — (String)

              The subject line, or title, of the email.

          • GCMMessage — (map)

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

            • Action — (String)

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

              • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

              • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

              • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

              Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • Body — (String)

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

            • ImageIconUrl — (String)

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

            • ImageSmallIconUrl — (String)

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

            • ImageUrl — (String)

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

            • JsonBody — (String)

              The JSON payload to use for a silent push notification.

            • MediaUrl — (String)

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

            • RawContent — (String)

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

            • SilentPush — (Boolean)

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

            • TimeToLive — (Integer)

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

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

            • Title — (String)

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

            • Url — (String)

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

          • SMSMessage — (map)

            The message that the campaign sends through the SMS channel.

            • Body — (String)

              The body of the SMS message.

            • MessageType — (String)

              The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.

              Possible values include:
              • "TRANSACTIONAL"
              • "PROMOTIONAL"
            • SenderId — (String)

              The sender ID to display on recipients' devices when they receive the SMS message.

        • Name — (String)

          The name of the campaign.

        • Schedule — (map)

          The schedule settings for the campaign.

          • EndTime — (String)

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

          • EventFilter — (map)

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

            • Dimensionsrequired — (map)

              The dimension settings of the event filter for the campaign.

              • Attributes — (map<map>)

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

                • AttributeType — (String)

                  The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                  Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Valuesrequired — (Array<String>)

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

              • EventType — (map)

                The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard type of event that Amazon Pinpoint generates, such as _email.delivered, or a custom event that's specific to your application.

                • DimensionType — (String)

                  The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                  Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Valuesrequired — (Array<String>)

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

              • Metrics — (map<map>)

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

                • ComparisonOperatorrequired — (String)

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

                • Valuerequired — (Float)

                  The value to compare.

            • FilterTyperequired — (String)

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

              Possible values include:
              • "SYSTEM"
              • "ENDPOINT"
          • Frequency — (String)

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

            Possible values include:
            • "ONCE"
            • "HOURLY"
            • "DAILY"
            • "WEEKLY"
            • "MONTHLY"
            • "EVENT"
          • IsLocalTime — (Boolean)

            Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.

          • QuietTime — (map)

            The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:

            • The EndpointDemographic.Timezone property of the endpoint is set to a valid value.

            • The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.

            • The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.

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

            • End — (String)

              The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

            • Start — (String)

              The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

          • StartTimerequired — (String)

            The scheduled time, in ISO 8601 format, when the campaign began or will begin.

          • Timezone — (String)

            The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.

        • SegmentIdrequired — (String)

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

        • SegmentVersionrequired — (Integer)

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

        • State — (map)

          The current status of the campaign.

          • CampaignStatus — (String)

            The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED.

            Possible values include:
            • "SCHEDULED"
            • "EXECUTING"
            • "PENDING_NEXT_RUN"
            • "COMPLETED"
            • "PAUSED"
            • "DELETED"
        • tags — (map<String>)

          A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.

        • TemplateConfiguration — (map)

          The message template that’s used for the campaign.

          • EmailTemplate — (map)

            The email template to use for the message.

            • Name — (String)

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

          • PushTemplate — (map)

            The push notification template to use for the message.

            • Name — (String)

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

          • SMSTemplate — (map)

            The SMS template to use for the message.

            • Name — (String)

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

          • VoiceTemplate — (map)

            The voice template to use for the message.

            • Name — (String)

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

        • TreatmentDescription — (String)

          The custom description of a variation of the campaign that's used for A/B testing.

        • TreatmentName — (String)

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

        • Version — (Integer)

          The version number of the campaign.

Returns:

  • (AWS.Request)

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

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

Disables the email channel for an application and deletes any existing settings for the 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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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)

        Provides information about the status and settings of the email channel for an application.

        • ApplicationId — (String)

          The unique identifier for the application that the email channel applies to.

        • ConfigurationSet — (String)

          The configuration set that's applied to email that's sent through the channel by using the Amazon Pinpoint Email API.

        • CreationDate — (String)

          The date and time, in ISO 8601 format, when the email channel was enabled.

        • Enabled — (Boolean)

          Specifies whether the email channel is enabled for the application.

        • FromAddress — (String)

          The verified email address that you send email from when you send email through the channel.

        • HasCredential — (Boolean)

          (Not used) This property is retained only for backward compatibility.

        • Id — (String)

          (Deprecated) An identifier for the email channel. This property is retained only for backward compatibility.

        • Identity — (String)

          The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that you use when you send email through the channel.

        • IsArchived — (Boolean)

          Specifies whether the email channel is archived.

        • LastModifiedBy — (String)

          The user who last modified the email channel.

        • LastModifiedDate — (String)

          The date and time, in ISO 8601 format, when the email channel was last modified.

        • MessagesPerSecond — (Integer)

          The maximum number of emails that you can send through the channel each second.

        • Platformrequired — (String)

          The type of messaging or notification platform for the channel. For the email channel, this value is EMAIL.

        • RoleArn — (String)

          The ARN of the AWS Identity and Access Management (IAM) role that Amazon Pinpoint uses to submit email-related event data for the channel.

        • Version — (Integer)

          The current version of the email channel.

Returns:

  • (AWS.Request)

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

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

Deletes a message template that was designed for use in messages that were sent through the email channel.

Service Reference:

Examples:

Calling the deleteEmailTemplate operation

var params = {
  TemplateName: 'STRING_VALUE' /* required */
};
pinpoint.deleteEmailTemplate(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: {})
    • TemplateName — (String)

      The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

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)

        Provides information about an API request or response.

        • Message — (String)

          The message that's returned from the API.

        • RequestID — (String)

          The unique identifier for the request or response.

Returns:

  • (AWS.Request)

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

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

Deletes an endpoint from an application.

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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    • EndpointId — (String)

      The unique identifier for 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)

        Provides information about the channel type and other settings for an endpoint.

        • Address — (String)

          The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For example, the address for a push-notification channel is typically the token provided by a push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. The address for the SMS channel is a phone number in E.164 format, such as +12065550100. The address for the email channel is an email address.

        • ApplicationId — (String)

          The unique identifier for the application that's associated with the endpoint.

        • Attributes — (map<Array<String>>)

          One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["science", "music", "travel"]. You can use these attributes as filter criteria when you create segments.

        • ChannelType — (String)

          The channel that's used when sending messages or push notifications to the endpoint.

          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 that the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an application. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for campaigns.

        • CreationDate — (String)

          The date and time, in ISO 8601 format, when the endpoint was created.

        • Demographic — (map)

          The demographic information for the endpoint, such as the time zone and platform.

          • AppVersion — (String)

            The version of the app that's associated with the endpoint.

          • Locale — (String)

            The locale of the endpoint, 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 time zone of the endpoint, specified as a tz database name value, such as America/Los_Angeles.

        • EffectiveDate — (String)

          The date and time, in ISO 8601 format, when the endpoint was last updated.

        • EndpointStatus — (String)

          Specifies whether messages or push notifications are sent to the endpoint. Possible values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.

          Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.

        • Id — (String)

          The unique identifier that you assigned to the endpoint. The identifier should be a globally unique identifier (GUID) to ensure that it doesn't conflict with other endpoint identifiers that are associated with the application.

        • Location — (map)

          The geographic information for the endpoint.

          • City — (String)

            The name of the city where the endpoint is located.

          • Country — (String)

            The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the endpoint is located. For example, US for the United States.

          • Latitude — (Float)

            The latitude coordinate of the endpoint location, rounded to one decimal place.

          • Longitude — (Float)

            The longitude coordinate of the endpoint location, rounded to one decimal place.

          • PostalCode — (String)

            The postal or ZIP code for the area where the endpoint is located.

          • Region — (String)

            The name of the region where the endpoint is located. For locations in the United States, this value is the name of a state.

        • Metrics — (map<Float>)

          One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.

        • OptOut — (String)

          Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.

        • RequestId — (String)

          The unique identifier for the most recent request to update the endpoint.

        • User — (map)

          One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.

          • UserAttributes — (map<Array<String>>)

            One or more custom attributes that describe the user by associating a name with an array of values. For example, the value of an attribute named Interests might be: ["science", "music", "travel"]. You can use these attributes as filter criteria when you create segments.

            When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This limitation doesn't apply to attribute values.

          • UserId — (String)

            The unique identifier for 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 application.

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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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)

        Specifies settings for publishing event data to an Amazon Kinesis data stream or an Amazon Kinesis Data Firehose delivery stream.

        • ApplicationIdrequired — (String)

          The unique identifier for the application to publish event data for.

        • DestinationStreamArnrequired — (String)

          The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream to publish event data to.

          For a Kinesis data stream, the ARN format is: arn:aws:kinesis:region:account-id:stream/stream_name

          For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region:account-id:deliverystream/stream_name

        • ExternalId — (String)

          (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when publishing event data, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.

        • LastModifiedDate — (String)

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

        • LastUpdatedBy — (String)

          The IAM user who last modified the event stream.

        • RoleArnrequired — (String)

          The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.

Returns:

  • (AWS.Request)

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

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

Disables the GCM channel for an application and deletes any existing settings for the channel.

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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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)

        Provides information about the status and settings of the GCM channel for an application. The GCM channel enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.

        • ApplicationId — (String)

          The unique identifier for the application that the GCM channel applies to.

        • CreationDate — (String)

          The date and time when the GCM channel was enabled.

        • Credentialrequired — (String)

          The Web API Key, also referred to as an API_KEY or server key, that you received from Google to communicate with Google services.

        • Enabled — (Boolean)

          Specifies whether the GCM channel is enabled for the application.

        • HasCredential — (Boolean)

          (Not used) This property is retained only for backward compatibility.

        • Id — (String)

          (Deprecated) An identifier for the GCM channel. This property is retained only for backward compatibility.

        • IsArchived — (Boolean)

          Specifies whether the GCM channel is archived.

        • LastModifiedBy — (String)

          The user who last modified the GCM channel.

        • LastModifiedDate — (String)

          The date and time when the GCM channel was last modified.

        • Platformrequired — (String)

          The type of messaging or notification platform for the channel. For the GCM channel, this value is GCM.

        • Version — (Integer)

          The current version of the GCM channel.

Returns:

  • (AWS.Request)

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

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

Deletes a journey from an application.

Service Reference:

Examples:

Calling the deleteJourney operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  JourneyId: 'STRING_VALUE' /* required */
};
pinpoint.deleteJourney(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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    • JourneyId — (String)

      The unique identifier for the journey.

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:

      • JourneyResponse — (map)

        Provides information about the status, configuration, and other settings for a journey.

        • Activities — (map<map>)

          The configuration and other settings for the activities that comprise the journey.

          • ConditionalSplit — (map)

            The settings for a yes/no split activity. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify.

            • Condition — (map)

              The conditions that define the paths for the activity, and the relationship between the conditions.

              • Conditions — (Array<map>)

                The conditions to evaluate for the activity.

                • EventCondition — (map)

                  The dimension settings for the event that's associated with the activity.

                  • Dimensionsrequired — (map)

                    The dimensions for the event filter to use for the activity.

                    • Attributes — (map<map>)

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

                      • AttributeType — (String)

                        The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                        Possible values include:
                        • "INCLUSIVE"
                        • "EXCLUSIVE"
                      • Valuesrequired — (Array<String>)

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

                    • EventType — (map)

                      The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard type of event that Amazon Pinpoint generates, such as _email.delivered, or a custom event that's specific to your application.

                      • DimensionType — (String)

                        The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                        Possible values include:
                        • "INCLUSIVE"
                        • "EXCLUSIVE"
                      • Valuesrequired — (Array<String>)

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

                    • Metrics — (map<map>)

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

                      • ComparisonOperatorrequired — (String)

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

                      • Valuerequired — (Float)

                        The value to compare.

                  • MessageActivity — (String)

                    The message identifier (message_id) for the message to use when determining whether message events meet the condition.

                • SegmentCondition — (map)

                  The segment that's associated with the activity.

                  • SegmentIdrequired — (String)

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

                • SegmentDimensions — (map)

                  The dimension settings for the segment that's associated with the activity.

                  • Attributes — (map<map>)

                    One or more custom attributes to use as criteria for the segment.

                    • AttributeType — (String)

                      The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                      Possible values include:
                      • "INCLUSIVE"
                      • "EXCLUSIVE"
                    • Valuesrequired — (Array<String>)

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

                  • Behavior — (map)

                    The behavior-based criteria, such as how recently users have used your app, for the segment.

                    • Recency — (map)

                      The dimension settings that are based on how recently an endpoint was active.

                      • Durationrequired — (String)

                        The duration to use when determining whether an endpoint is active or inactive.

                        Possible values include:
                        • "HR_24"
                        • "DAY_7"
                        • "DAY_14"
                        • "DAY_30"
                      • RecencyTyperequired — (String)

                        The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.

                        Possible values include:
                        • "ACTIVE"
                        • "INACTIVE"
                  • Demographic — (map)

                    The demographic-based criteria, such as device platform, for the segment.

                    • AppVersion — (map)

                      The app version criteria for the segment.

                      • DimensionType — (String)

                        The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                        Possible values include:
                        • "INCLUSIVE"
                        • "EXCLUSIVE"
                      • Valuesrequired — (Array<String>)

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

                    • Channel — (map)

                      The channel criteria for the segment.

                      • DimensionType — (String)

                        The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                        Possible values include:
                        • "INCLUSIVE"
                        • "EXCLUSIVE"
                      • Valuesrequired — (Array<String>)

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

                    • DeviceType — (map)

                      The device type criteria for the segment.

                      • DimensionType — (String)

                        The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                        Possible values include:
                        • "INCLUSIVE"
                        • "EXCLUSIVE"
                      • Valuesrequired — (Array<String>)

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

                    • Make — (map)

                      The device make criteria for the segment.

                      • DimensionType — (String)

                        The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                        Possible values include:
                        • "INCLUSIVE"
                        • "EXCLUSIVE"
                      • Valuesrequired — (Array<String>)

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

                    • Model — (map)

                      The device model criteria for the segment.

                      • DimensionType — (String)

                        The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                        Possible values include:
                        • "INCLUSIVE"
                        • "EXCLUSIVE"
                      • Valuesrequired — (Array<String>)

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

                    • Platform — (map)

                      The device platform criteria for the segment.

                      • DimensionType — (String)

                        The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                        Possible values include:
                        • "INCLUSIVE"
                        • "EXCLUSIVE"
                      • Valuesrequired — (Array<String>)

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

                  • Location — (map)

                    The location-based criteria, such as region or GPS coordinates, for the segment.

                    • Country — (map)

                      The country or region code, in ISO 3166-1 alpha-2 format, for the segment.

                      • DimensionType — (String)

                        The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                        Possible values include:
                        • "INCLUSIVE"
                        • "EXCLUSIVE"
                      • Valuesrequired — (Array<String>)

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

                    • GPSPoint — (map)

                      The GPS location and range for the segment.

                      • Coordinatesrequired — (map)

                        The GPS coordinates to measure distance from.

                        • Latituderequired — (Float)

                          The latitude coordinate of the location.

                        • Longituderequired — (Float)

                          The longitude coordinate of the location.

                      • RangeInKilometers — (Float)

                        The range, in kilometers, from the GPS coordinates.

                  • Metrics — (map<map>)

                    One or more custom metrics to use as criteria for the segment.

                    • ComparisonOperatorrequired — (String)

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

                    • Valuerequired — (Float)

                      The value to compare.

                  • UserAttributes — (map<map>)

                    One or more custom user attributes to use as criteria for the segment.

                    • AttributeType — (String)

                      The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                      Possible values include:
                      • "INCLUSIVE"
                      • "EXCLUSIVE"
                    • Valuesrequired — (Array<String>)

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

              • Operator — (String)

                Specifies how to handle multiple conditions for the activity. For example, if you specify two conditions for an activity, whether both or only one of the conditions must be met for the activity to be performed.

                Possible values include:
                • "ALL"
                • "ANY"
            • EvaluationWaitTime — (map)

              The amount of time to wait before determining whether the conditions are met, or the date and time when Amazon Pinpoint determines whether the conditions are met.

              • WaitFor — (String)

                The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.

              • WaitUntil — (String)

                The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.

            • FalseActivity — (String)

              The unique identifier for the activity to perform if the condition isn't met.

            • TrueActivity — (String)

              The unique identifier for the activity to perform if the condition is met.

          • Description — (String)

            The custom description of the activity.

          • EMAIL — (map)

            The settings for an email activity. This type of activity sends an email message to participants.

            • MessageConfig — (map)

              The "From" address to use for the message.

              • FromAddress — (String)

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

            • NextActivity — (String)

              The unique identifier for the next activity to perform, after the message is sent.

            • TemplateName — (String)

              The name of the email template to use for the message.

          • Holdout — (map)

            The settings for a holdout activity. This type of activity stops a journey for a specified percentage of participants.

            • NextActivity — (String)

              The unique identifier for the next activity to perform, after performing the holdout activity.

            • Percentagerequired — (Integer)

              The percentage of participants who shouldn't continue the journey.

          • MultiCondition — (map)

            The settings for a multivariate split activity. This type of activity sends participants down one of as many as five paths in a journey, based on conditions that you specify.

            • Branches — (Array<map>)

              The paths for the activity, including the conditions for entering each path and the activity to perform for each path.

              • Condition — (map)

                The condition to evaluate for the activity path.

                • EventCondition — (map)

                  The dimension settings for the event that's associated with the activity.

                  • Dimensionsrequired — (map)

                    The dimensions for the event filter to use for the activity.

                    • Attributes — (map<map>)

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

                      • AttributeType — (String)

                        The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                        Possible values include:
                        • "INCLUSIVE"
                        • "EXCLUSIVE"
                      • Valuesrequired — (Array<String>)

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

                    • EventType — (map)

                      The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard type of event that Amazon Pinpoint generates, such as _email.delivered, or a custom event that's specific to your application.

                      • DimensionType — (String)

                        The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                        Possible values include:
                        • "INCLUSIVE"
                        • "EXCLUSIVE"
                      • Valuesrequired — (Array<String>)

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

                    • Metrics — (map<map>)

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

                      • ComparisonOperatorrequired — (String)

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

                      • Valuerequired — (Float)

                        The value to compare.

                  • MessageActivity — (String)

                    The message identifier (message_id) for the message to use when determining whether message events meet the condition.

                • SegmentCondition — (map)

                  The segment that's associated with the activity.

                  • SegmentIdrequired — (String)

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

                • SegmentDimensions — (map)

                  The dimension settings for the segment that's associated with the activity.

                  • Attributes — (map<map>)

                    One or more custom attributes to use as criteria for the segment.

                    • AttributeType — (String)

                      The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                      Possible values include:
                      • "INCLUSIVE"
                      • "EXCLUSIVE"
                    • Valuesrequired — (Array<String>)

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

                  • Behavior — (map)

                    The behavior-based criteria, such as how recently users have used your app, for the segment.

                    • Recency — (map)

                      The dimension settings that are based on how recently an endpoint was active.

                      • Durationrequired — (String)

                        The duration to use when determining whether an endpoint is active or inactive.

                        Possible values include:
                        • "HR_24"
                        • "DAY_7"
                        • "DAY_14"
                        • "DAY_30"
                      • RecencyTyperequired — (String)

                        The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.

                        Possible values include:
                        • "ACTIVE"
                        • "INACTIVE"
                  • Demographic — (map)

                    The demographic-based criteria, such as device platform, for the segment.

                    • AppVersion — (map)

                      The app version criteria for the segment.

                      • DimensionType — (String)

                        The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                        Possible values include:
                        • "INCLUSIVE"
                        • "EXCLUSIVE"
                      • Valuesrequired — (Array<String>)

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

                    • Channel — (map)

                      The channel criteria for the segment.

                      • DimensionType — (String)

                        The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                        Possible values include:
                        • "INCLUSIVE"
                        • "EXCLUSIVE"
                      • Valuesrequired — (Array<String>)

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

                    • DeviceType — (map)

                      The device type criteria for the segment.

                      • DimensionType — (String)

                        The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                        Possible values include:
                        • "INCLUSIVE"
                        • "EXCLUSIVE"
                      • Valuesrequired — (Array<String>)

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

                    • Make — (map)

                      The device make criteria for the segment.

                      • DimensionType — (String)

                        The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                        Possible values include:
                        • "INCLUSIVE"
                        • "EXCLUSIVE"
                      • Valuesrequired — (Array<String>)

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

                    • Model — (map)

                      The device model criteria for the segment.

                      • DimensionType — (String)

                        The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                        Possible values include:
                        • "INCLUSIVE"
                        • "EXCLUSIVE"
                      • Valuesrequired — (Array<String>)

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

                    • Platform — (map)

                      The device platform criteria for the segment.

                      • DimensionType — (String)

                        The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                        Possible values include:
                        • "INCLUSIVE"
                        • "EXCLUSIVE"
                      • Valuesrequired — (Array<String>)

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

                  • Location — (map)

                    The location-based criteria, such as region or GPS coordinates, for the segment.

                    • Country — (map)

                      The country or region code, in ISO 3166-1 alpha-2 format, for the segment.

                      • DimensionType — (String)

                        The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                        Possible values include:
                        • "INCLUSIVE"
                        • "EXCLUSIVE"
                      • Valuesrequired — (Array<String>)

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

                    • GPSPoint — (map)

                      The GPS location and range for the segment.

                      • Coordinatesrequired — (map)

                        The GPS coordinates to measure distance from.

                        • Latituderequired — (Float)

                          The latitude coordinate of the location.

                        • Longituderequired — (Float)

                          The longitude coordinate of the location.

                      • RangeInKilometers — (Float)

                        The range, in kilometers, from the GPS coordinates.

                  • Metrics — (map<map>)

                    One or more custom metrics to use as criteria for the segment.

                    • ComparisonOperatorrequired — (String)

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

                    • Valuerequired — (Float)

                      The value to compare.

                  • UserAttributes — (map<map>)

                    One or more custom user attributes to use as criteria for the segment.

                    • AttributeType — (String)

                      The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                      Possible values include:
                      • "INCLUSIVE"
                      • "EXCLUSIVE"
                    • Valuesrequired — (Array<String>)

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

              • NextActivity — (String)

                The unique identifier for the next activity to perform, after completing the activity for the path.

            • DefaultActivity — (String)

              The activity to perform by default for any path in the activity.

            • EvaluationWaitTime — (map)

              The amount of time to wait or the date and time when Amazon Pinpoint determines whether the conditions are met.

              • WaitFor — (String)

                The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.

              • WaitUntil — (String)

                The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.

          • RandomSplit — (map)

            The settings for a random split activity. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify.

            • Branches — (Array<map>)

              The paths for the activity, including the percentage of participants to enter each path and the activity to perform for each path.

              • NextActivity — (String)

                The unique identifier for the next activity to perform, after completing the activity for the path.

              • Percentage — (Integer)

                The percentage of participants to send down the activity path.

          • Wait — (map)

            The settings for a wait activity. This type of activity waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.

            • NextActivity — (String)

              The unique identifier for the next activity to perform, after performing the wait activity.

            • WaitTime — (map)

              The amount of time to wait or the date and time when the activity moves participants to the next activity in the journey.

              • WaitFor — (String)

                The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.

              • WaitUntil — (String)

                The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.

        • ApplicationIdrequired — (String)

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

        • CreationDate — (String)

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

        • Idrequired — (String)

          The unique identifier for the journey.

        • LastModifiedDate — (String)

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

        • Limits — (map)

          The messaging and entry limits for the journey.

          • DailyCap — (Integer)

            The maximum number of messages that the journey can send to a single participant during a 24-hour period. The maximum value is 100.

          • EndpointReentryCap — (Integer)

            The maximum number of times that a participant can enter the journey. The maximum value is 100. To allow participants to enter the journey an unlimited number of times, set this value to 0.

          • MessagesPerSecond — (Integer)

            The maximum number of messages that the journey can send each second.

        • LocalTime — (Boolean)

          Specifies whether the journey's scheduled start and end times use each participant's local time. If this value is true, the schedule uses each participant's local time.

        • Namerequired — (String)

          The name of the journey.

        • QuietTime — (map)

          The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:

          • The EndpointDemographic.Timezone property of the endpoint for the participant is set to a valid value.

          • The current time in the participant's time zone is later than or equal to the time specified by the QuietTime.Start property for the journey.

          • The current time in the participant's time zone is earlier than or equal to the time specified by the QuietTime.End property for the journey.

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

          • End — (String)

            The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

          • Start — (String)

            The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

        • RefreshFrequency — (String)

          The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.

        • Schedule — (map)

          The schedule settings for the journey.

          • EndTime — (Date)

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

          • StartTime — (Date)

            The scheduled time, in ISO 8601 format, when the journey began or will begin.

          • Timezone — (String)

            The starting UTC offset for the journey schedule, if the value of the journey's LocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+08:45, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+12:45, UTC+13, UTC+13:45, UTC-02, UTC-02:30, UTC-03, UTC-03:30, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-09:30, UTC-10, and UTC-11.

        • StartActivity — (String)

          The unique identifier for the first activity in the journey.

        • StartCondition — (map)

          The segment that defines which users are participants in the journey.

          • Description — (String)

            The custom description of the condition.

          • SegmentStartCondition — (map)

            The segment that's associated with the first activity in the journey. This segment determines which users are participants in the journey.

            • SegmentIdrequired — (String)

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

        • State — (String)

          The current status of the journey. Possible values are:

          • DRAFT - The journey is being developed and hasn't been published yet.

          • ACTIVE - The journey has been developed and published. Depending on the journey's schedule, the journey may currently be running or scheduled to start running at a later time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.

          • COMPLETED - The journey has been published and has finished running. All participants have entered the journey and no participants are waiting to complete the journey or any activities in the journey.

          • CANCELLED - The journey has been stopped. If a journey's status is CANCELLED, you can't add, change, or remove activities or segment settings from the journey.

          • CLOSED - The journey has been published and has started running. It may have also passed its scheduled end time, or passed its scheduled start time and a refresh frequency hasn't been specified for it. If a journey's status is CLOSED, you can't add participants to it, and no existing participants can enter the journey for the first time. However, any existing participants who are currently waiting to start an activity may resume the journey.

          Possible values include:
          • "DRAFT"
          • "ACTIVE"
          • "COMPLETED"
          • "CANCELLED"
          • "CLOSED"
        • tags — (map<String>)

          A string-to-string map of key-value pairs that identifies the tags that are associated with the journey. Each tag consists of a required tag key and an associated tag value.

Returns:

  • (AWS.Request)

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

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

Deletes a message template that was designed for use in messages that were sent through a push notification channel.

Service Reference:

Examples:

Calling the deletePushTemplate operation

var params = {
  TemplateName: 'STRING_VALUE' /* required */
};
pinpoint.deletePushTemplate(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: {})
    • TemplateName — (String)

      The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

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)

        Provides information about an API request or response.

        • Message — (String)

          The message that's returned from the API.

        • RequestID — (String)

          The unique identifier for the request or response.

Returns:

  • (AWS.Request)

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

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

Deletes a segment from an application.

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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    • SegmentId — (String)

      The unique identifier for 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)

        Provides information about the configuration, dimension, and other settings for a segment.

        • ApplicationIdrequired — (String)

          The unique identifier for the application that the segment is associated with.

        • Arnrequired — (String)

          The Amazon Resource Name (ARN) of the segment.

        • CreationDaterequired — (String)

          The date and time when the segment was created.

        • Dimensions — (map)

          The dimension settings for the segment.

          • Attributes — (map<map>)

            One or more custom attributes to use as criteria for the segment.

            • AttributeType — (String)

              The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

              Possible values include:
              • "INCLUSIVE"
              • "EXCLUSIVE"
            • Valuesrequired — (Array<String>)

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

          • Behavior — (map)

            The behavior-based criteria, such as how recently users have used your app, for the segment.

            • Recency — (map)

              The dimension settings that are based on how recently an endpoint was active.

              • Durationrequired — (String)

                The duration to use when determining whether an endpoint is active or inactive.

                Possible values include:
                • "HR_24"
                • "DAY_7"
                • "DAY_14"
                • "DAY_30"
              • RecencyTyperequired — (String)

                The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.

                Possible values include:
                • "ACTIVE"
                • "INACTIVE"
          • Demographic — (map)

            The demographic-based criteria, such as device platform, for the segment.

            • AppVersion — (map)

              The app version criteria for the segment.

              • DimensionType — (String)

                The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Valuesrequired — (Array<String>)

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

            • Channel — (map)

              The channel criteria for the segment.

              • DimensionType — (String)

                The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Valuesrequired — (Array<String>)

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

            • DeviceType — (map)

              The device type criteria for the segment.

              • DimensionType — (String)

                The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Valuesrequired — (Array<String>)

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

            • Make — (map)

              The device make criteria for the segment.

              • DimensionType — (String)

                The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Valuesrequired — (Array<String>)

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

            • Model — (map)

              The device model criteria for the segment.

              • DimensionType — (String)

                The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Valuesrequired — (Array<String>)

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

            • Platform — (map)

              The device platform criteria for the segment.

              • DimensionType — (String)

                The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Valuesrequired — (Array<String>)

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

          • Location — (map)

            The location-based criteria, such as region or GPS coordinates, for the segment.

            • Country — (map)

              The country or region code, in ISO 3166-1 alpha-2 format, for the segment.

              • DimensionType — (String)

                The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                Possible values include:
                • "INCLUSIVE"
                • "EXCLUSIVE"
              • Valuesrequired — (Array<String>)

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

            • GPSPoint — (map)

              The GPS location and range for the segment.

              • Coordinatesrequired — (map)

                The GPS coordinates to measure distance from.

                • Latituderequired — (Float)

                  The latitude coordinate of the location.

                • Longituderequired — (Float)

                  The longitude coordinate of the location.

              • RangeInKilometers — (Float)

                The range, in kilometers, from the GPS coordinates.

          • Metrics — (map<map>)

            One or more custom metrics to use as criteria for the segment.

            • ComparisonOperatorrequired — (String)

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

            • Valuerequired — (Float)

              The value to compare.

          • UserAttributes — (map<map>)

            One or more custom user attributes to use as criteria for the segment.

            • AttributeType — (String)

              The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

              Possible values include:
              • "INCLUSIVE"
              • "EXCLUSIVE"
            • Valuesrequired — (Array<String>)

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

        • Idrequired — (String)

          The unique identifier for the segment.

        • ImportDefinition — (map)

          The settings for the import job that's associated with the segment.

          • ChannelCounts — (map<Integer>)

            The number of channel types in the endpoint definitions that were imported to create the segment.

          • ExternalIdrequired — (String)

            (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.

          • Formatrequired — (String)

            The format of the files that were imported to create the segment. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.

            Possible values include:
            • "CSV"
            • "JSON"
          • RoleArnrequired — (String)

            The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.

          • S3Urlrequired — (String)

            The URL of the Amazon Simple Storage Service (Amazon S3) bucket that the endpoint definitions were imported from to create the segment.

          • Sizerequired — (Integer)

            The number of endpoint definitions that were imported successfully to create the segment.

        • LastModifiedDate — (String)

          The date and time when the segment was last modified.

        • Name — (String)

          The name of the segment.

        • SegmentGroups — (map)

          A list of one or more segment groups that apply to the segment. Each segment group consists of zero or more base segments and the dimensions that are applied to those base segments.

          • Groups — (Array<map>)

            An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.

            • Dimensions — (Array<map>)

              An array that defines the dimensions for the segment.

              • Attributes — (map<map>)

                One or more custom attributes to use as criteria for the segment.

                • AttributeType — (String)

                  The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                  Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Valuesrequired — (Array<String>)

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

              • Behavior — (map)

                The behavior-based criteria, such as how recently users have used your app, for the segment.

                • Recency — (map)

                  The dimension settings that are based on how recently an endpoint was active.

                  • Durationrequired — (String)

                    The duration to use when determining whether an endpoint is active or inactive.

                    Possible values include:
                    • "HR_24"
                    • "DAY_7"
                    • "DAY_14"
                    • "DAY_30"
                  • RecencyTyperequired — (String)

                    The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.

                    Possible values include:
                    • "ACTIVE"
                    • "INACTIVE"
              • Demographic — (map)

                The demographic-based criteria, such as device platform, for the segment.

                • AppVersion — (map)

                  The app version criteria for the segment.

                  • DimensionType — (String)

                    The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                    Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Valuesrequired — (Array<String>)

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

                • Channel — (map)

                  The channel criteria for the segment.

                  • DimensionType — (String)

                    The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                    Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Valuesrequired — (Array<String>)

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

                • DeviceType — (map)

                  The device type criteria for the segment.

                  • DimensionType — (String)

                    The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                    Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Valuesrequired — (Array<String>)

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

                • Make — (map)

                  The device make criteria for the segment.

                  • DimensionType — (String)

                    The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                    Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Valuesrequired — (Array<String>)

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

                • Model — (map)

                  The device model criteria for the segment.

                  • DimensionType — (String)

                    The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                    Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Valuesrequired — (Array<String>)

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

                • Platform — (map)

                  The device platform criteria for the segment.

                  • DimensionType — (String)

                    The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                    Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Valuesrequired — (Array<String>)

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

              • Location — (map)

                The location-based criteria, such as region or GPS coordinates, for the segment.

                • Country — (map)

                  The country or region code, in ISO 3166-1 alpha-2 format, for the segment.

                  • DimensionType — (String)

                    The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                    Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Valuesrequired — (Array<String>)

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

                • GPSPoint — (map)

                  The GPS location and range for the segment.

                  • Coordinatesrequired — (map)

                    The GPS coordinates to measure distance from.

                    • Latituderequired — (Float)

                      The latitude coordinate of the location.

                    • Longituderequired — (Float)

                      The longitude coordinate of the location.

                  • RangeInKilometers — (Float)

                    The range, in kilometers, from the GPS coordinates.

              • Metrics — (map<map>)

                One or more custom metrics to use as criteria for the segment.

                • ComparisonOperatorrequired — (String)

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

                • Valuerequired — (Float)

                  The value to compare.

              • UserAttributes — (map<map>)

                One or more custom user attributes to use as criteria for the segment.

                • AttributeType — (String)

                  The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                  Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Valuesrequired — (Array<String>)

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

            • SourceSegments — (Array<map>)

              The base segment to build the segment on. A base segment, also referred to as a source segment, defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify.

              You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size of the imported segment without any filters applied to it.

              • Idrequired — (String)

                The unique identifier for the segment.

              • Version — (Integer)

                The version number of the segment.

            • SourceType — (String)

              Specifies how to handle multiple base segments for the segment. For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.

              Possible values include:
              • "ALL"
              • "ANY"
              • "NONE"
            • Type — (String)

              Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.

              Possible values include:
              • "ALL"
              • "ANY"
              • "NONE"
          • Include — (String)

            Specifies how to handle multiple segment groups for the segment. For example, if the segment includes three segment groups, whether the resulting segment includes endpoints that match all, any, or none of the segment groups.

            Possible values include:
            • "ALL"
            • "ANY"
            • "NONE"
        • SegmentTyperequired — (String)

          The segment type. Valid values are:

          • DIMENSIONAL - A dynamic segment, which is a segment that uses selection criteria that you specify and is based on endpoint data that's reported by your app. Dynamic segments can change over time.

          • IMPORT - A static segment, which is a segment that uses selection criteria that you specify and is based on endpoint definitions that you import from a file. Imported segments are static; they don't change over time.

          Possible values include:
          • "DIMENSIONAL"
          • "IMPORT"
        • tags — (map<String>)

          A string-to-string map of key-value pairs that identifies the tags that are associated with the segment. Each tag consists of a required tag key and an associated tag value.

        • Version — (Integer)

          The version number of the segment.

Returns:

  • (AWS.Request)

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

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

Disables the SMS channel for an application and deletes any existing settings for the 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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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)

        Provides information about the status and settings of the SMS channel for an application.

        • ApplicationId — (String)

          The unique identifier for the application that the SMS channel applies to.

        • CreationDate — (String)

          The date and time, in ISO 8601 format, when the SMS channel was enabled.

        • Enabled — (Boolean)

          Specifies whether the SMS channel is enabled for the application.

        • HasCredential — (Boolean)

          (Not used) This property is retained only for backward compatibility.

        • Id — (String)

          (Deprecated) An identifier for the SMS channel. This property is retained only for backward compatibility.

        • IsArchived — (Boolean)

          Specifies whether the SMS channel is archived.

        • LastModifiedBy — (String)

          The user who last modified the SMS channel.

        • LastModifiedDate — (String)

          The date and time, in ISO 8601 format, when the SMS channel was last modified.

        • Platformrequired — (String)

          The type of messaging or notification platform for the channel. For the SMS channel, this value is SMS.

        • PromotionalMessagesPerSecond — (Integer)

          The maximum number of promotional messages that you can send through the SMS channel each second.

        • SenderId — (String)

          The identity that displays on recipients' devices when they receive messages from the SMS channel.

        • ShortCode — (String)

          The registered short code to use when you send messages through the SMS channel.

        • TransactionalMessagesPerSecond — (Integer)

          The maximum number of transactional messages that you can send through the SMS channel each second.

        • Version — (Integer)

          The current version of the SMS channel.

Returns:

  • (AWS.Request)

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

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

Deletes a message template that was designed for use in messages that were sent through the SMS channel.

Service Reference:

Examples:

Calling the deleteSmsTemplate operation

var params = {
  TemplateName: 'STRING_VALUE' /* required */
};
pinpoint.deleteSmsTemplate(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: {})
    • TemplateName — (String)

      The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

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)

        Provides information about an API request or response.

        • Message — (String)

          The message that's returned from the API.

        • RequestID — (String)

          The unique identifier for the request or response.

Returns:

  • (AWS.Request)

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

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

Deletes all the endpoints that are associated with a specific 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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    • UserId — (String)

      The unique identifier for 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)

        Provides information about all the endpoints that are associated with a user ID.

        • Itemrequired — (Array<map>)

          An array of responses, one for each endpoint that's associated with the user ID.

          • Address — (String)

            The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For example, the address for a push-notification channel is typically the token provided by a push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. The address for the SMS channel is a phone number in E.164 format, such as +12065550100. The address for the email channel is an email address.

          • ApplicationId — (String)

            The unique identifier for the application that's associated with the endpoint.

          • Attributes — (map<Array<String>>)

            One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["science", "music", "travel"]. You can use these attributes as filter criteria when you create segments.

          • ChannelType — (String)

            The channel that's used when sending messages or push notifications to the endpoint.

            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 that the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an application. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for campaigns.

          • CreationDate — (String)

            The date and time, in ISO 8601 format, when the endpoint was created.

          • Demographic — (map)

            The demographic information for the endpoint, such as the time zone and platform.

            • AppVersion — (String)

              The version of the app that's associated with the endpoint.

            • Locale — (String)

              The locale of the endpoint, 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 time zone of the endpoint, specified as a tz database name value, such as America/Los_Angeles.

          • EffectiveDate — (String)

            The date and time, in ISO 8601 format, when the endpoint was last updated.

          • EndpointStatus — (String)

            Specifies whether messages or push notifications are sent to the endpoint. Possible values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.

            Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.

          • Id — (String)

            The unique identifier that you assigned to the endpoint. The identifier should be a globally unique identifier (GUID) to ensure that it doesn't conflict with other endpoint identifiers that are associated with the application.

          • Location — (map)

            The geographic information for the endpoint.

            • City — (String)

              The name of the city where the endpoint is located.

            • Country — (String)

              The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the endpoint is located. For example, US for the United States.

            • Latitude — (Float)

              The latitude coordinate of the endpoint location, rounded to one decimal place.

            • Longitude — (Float)

              The longitude coordinate of the endpoint location, rounded to one decimal place.

            • PostalCode — (String)

              The postal or ZIP code for the area where the endpoint is located.

            • Region — (String)

              The name of the region where the endpoint is located. For locations in the United States, this value is the name of a state.

          • Metrics — (map<Float>)

            One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.

          • OptOut — (String)

            Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.

          • RequestId — (String)

            The unique identifier for the most recent request to update the endpoint.

          • User — (map)

            One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.

            • UserAttributes — (map<Array<String>>)

              One or more custom attributes that describe the user by associating a name with an array of values. For example, the value of an attribute named Interests might be: ["science", "music", "travel"]. You can use these attributes as filter criteria when you create segments.

              When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This limitation doesn't apply to attribute values.

            • UserId — (String)

              The unique identifier for the user.

Returns:

  • (AWS.Request)

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

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

Disables the voice channel for an application and deletes any existing settings for the 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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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)

        Provides information about the status and settings of the voice channel for an application.

        • ApplicationId — (String)

          The unique identifier for the application that the voice channel applies to.

        • CreationDate — (String)

          The date and time, in ISO 8601 format, when the voice channel was enabled.

        • Enabled — (Boolean)

          Specifies whether the voice channel is enabled for the application.

        • HasCredential — (Boolean)

          (Not used) This property is retained only for backward compatibility.

        • Id — (String)

          (Deprecated) An identifier for the voice channel. This property is retained only for backward compatibility.

        • IsArchived — (Boolean)

          Specifies whether the voice channel is archived.

        • LastModifiedBy — (String)

          The user who last modified the voice channel.

        • LastModifiedDate — (String)

          The date and time, in ISO 8601 format, when the voice channel was last modified.

        • Platformrequired — (String)

          The type of messaging or notification platform for the channel. For the voice channel, this value is VOICE.

        • Version — (Integer)

          The current version of the voice channel.

Returns:

  • (AWS.Request)

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

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

Deletes a message template that was designed for use in messages that were sent through the voice channel.

Service Reference:

Examples:

Calling the deleteVoiceTemplate operation

var params = {
  TemplateName: 'STRING_VALUE' /* required */
};
pinpoint.deleteVoiceTemplate(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: {})
    • TemplateName — (String)

      The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

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)

        Provides information about an API request or response.

        • Message — (String)

          The message that's returned from the API.

        • RequestID — (String)

          The unique identifier for the request or response.

Returns:

  • (AWS.Request)

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

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

Retrieves information about the status and settings of the ADM channel for an application.

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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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)

        Provides information about the status and settings of the ADM (Amazon Device Messaging) channel for an application.

        • ApplicationId — (String)

          The unique identifier for the application that the ADM channel applies to.

        • CreationDate — (String)

          The date and time when the ADM channel was enabled.

        • Enabled — (Boolean)

          Specifies whether the ADM channel is enabled for the application.

        • HasCredential — (Boolean)

          (Not used) This property is retained only for backward compatibility.

        • Id — (String)

          (Deprecated) An identifier for the ADM channel. This property is retained only for backward compatibility.

        • IsArchived — (Boolean)

          Specifies whether the ADM channel is archived.

        • LastModifiedBy — (String)

          The user who last modified the ADM channel.

        • LastModifiedDate — (String)

          The date and time when the ADM channel was last modified.

        • Platformrequired — (String)

          The type of messaging or notification platform for the channel. For the ADM channel, this value is ADM.

        • Version — (Integer)

          The current version of the ADM channel.

Returns:

  • (AWS.Request)

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

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

Retrieves information about the status and settings of the APNs channel for an application.

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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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)

        Provides information about the status and settings of the APNs (Apple Push Notification service) channel for an application.

        • ApplicationId — (String)

          The unique identifier for the application that the APNs channel applies to.

        • CreationDate — (String)

          The date and time when the APNs channel was enabled.

        • DefaultAuthenticationMethod — (String)

          The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate.

        • Enabled — (Boolean)

          Specifies whether the APNs channel is enabled for the application.

        • HasCredential — (Boolean)

          (Not used) This property is retained only for backward compatibility.

        • HasTokenKey — (Boolean)

          Specifies whether the APNs channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.

        • Id — (String)

          (Deprecated) An identifier for the APNs channel. This property is retained only for backward compatibility.

        • IsArchived — (Boolean)

          Specifies whether the APNs channel is archived.

        • LastModifiedBy — (String)

          The user who last modified the APNs channel.

        • LastModifiedDate — (String)

          The date and time when the APNs channel was last modified.

        • Platformrequired — (String)

          The type of messaging or notification platform for the channel. For the APNs channel, this value is APNS.

        • Version — (Integer)

          The current version of the APNs channel.

Returns:

  • (AWS.Request)

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

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

Retrieves information about the status and settings of the APNs sandbox channel for an application.

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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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)

        Provides information about the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.

        • ApplicationId — (String)

          The unique identifier for the application that the APNs sandbox channel applies to.

        • CreationDate — (String)

          The date and time when the APNs sandbox channel was enabled.

        • DefaultAuthenticationMethod — (String)

          The default authentication method that Amazon Pinpoint uses to authenticate with the APNs sandbox environment for this channel, key or certificate.

        • Enabled — (Boolean)

          Specifies whether the APNs sandbox channel is enabled for the application.

        • HasCredential — (Boolean)

          (Not used) This property is retained only for backward compatibility.

        • HasTokenKey — (Boolean)

          Specifies whether the APNs sandbox channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.

        • Id — (String)

          (Deprecated) An identifier for the APNs sandbox channel. This property is retained only for backward compatibility.

        • IsArchived — (Boolean)

          Specifies whether the APNs sandbox channel is archived.

        • LastModifiedBy — (String)

          The user who last modified the APNs sandbox channel.

        • LastModifiedDate — (String)

          The date and time when the APNs sandbox channel was last modified.

        • Platformrequired — (String)

          The type of messaging or notification platform for the channel. For the APNs sandbox channel, this value is APNS_SANDBOX.

        • Version — (Integer)

          The current version of the APNs sandbox channel.

Returns:

  • (AWS.Request)

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

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

Retrieves information about the status and settings of the APNs VoIP channel for an application.

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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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)

        Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.

        • ApplicationId — (String)

          The unique identifier for the application that the APNs VoIP channel applies to.

        • CreationDate — (String)

          The date and time when the APNs VoIP channel was enabled.

        • DefaultAuthenticationMethod — (String)

          The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate.

        • Enabled — (Boolean)

          Specifies whether the APNs VoIP channel is enabled for the application.

        • HasCredential — (Boolean)

          (Not used) This property is retained only for backward compatibility.

        • HasTokenKey — (Boolean)

          Specifies whether the APNs VoIP channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.

        • Id — (String)

          (Deprecated) An identifier for the APNs VoIP channel. This property is retained only for backward compatibility.

        • IsArchived — (Boolean)

          Specifies whether the APNs VoIP channel is archived.

        • LastModifiedBy — (String)

          The user who last modified the APNs VoIP channel.

        • LastModifiedDate — (String)

          The date and time when the APNs VoIP channel was last modified.

        • Platformrequired — (String)

          The type of messaging or notification platform for the channel. For the APNs VoIP channel, this value is APNS_VOIP.

        • Version — (Integer)

          The current version of the APNs VoIP channel.

Returns:

  • (AWS.Request)

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

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

Retrieves information about the status and settings of the APNs VoIP sandbox channel for an application.

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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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)

        Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application.

        • ApplicationId — (String)

          The unique identifier for the application that the APNs VoIP sandbox channel applies to.

        • CreationDate — (String)

          The date and time when the APNs VoIP sandbox channel was enabled.

        • DefaultAuthenticationMethod — (String)

          The default authentication method that Amazon Pinpoint uses to authenticate with the APNs sandbox environment for this channel, key or certificate.

        • Enabled — (Boolean)

          Specifies whether the APNs VoIP sandbox channel is enabled for the application.

        • HasCredential — (Boolean)

          (Not used) This property is retained only for backward compatibility.

        • HasTokenKey — (Boolean)

          Specifies whether the APNs VoIP sandbox channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.

        • Id — (String)

          (Deprecated) An identifier for the APNs VoIP sandbox channel. This property is retained only for backward compatibility.

        • IsArchived — (Boolean)

          Specifies whether the APNs VoIP sandbox channel is archived.

        • LastModifiedBy — (String)

          The user who last modified the APNs VoIP sandbox channel.

        • LastModifiedDate — (String)

          The date and time when the APNs VoIP sandbox channel was last modified.

        • Platformrequired — (String)

          The type of messaging or notification platform for the channel. For the APNs VoIP sandbox channel, this value is APNS_VOIP_SANDBOX.

        • Version — (Integer)

          The current version of the APNs VoIP sandbox channel.

Returns:

  • (AWS.Request)

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

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

Retrieves information about an application.

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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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)

        Provides information about an application.

        • Arnrequired — (String)

          The Amazon Resource Name (ARN) of the application.

        • Idrequired — (String)

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

        • Namerequired — (String)

          The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console.

        • tags — (map<String>)

          A string-to-string map of key-value pairs that identifies the tags that are associated with the application. Each tag consists of a required tag key and an associated tag value.

Returns:

  • (AWS.Request)

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

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

Retrieves (queries) pre-aggregated data for a standard metric that applies to an application.

Service Reference:

Examples:

Calling the getApplicationDateRangeKpi operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  KpiName: 'STRING_VALUE', /* required */
  EndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  NextToken: 'STRING_VALUE',
  PageSize: 'STRING_VALUE',
  StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
pinpoint.getApplicationDateRangeKpi(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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    • EndTime — (Date)

      The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format, for example: 2019-07-19T00:00:00Z for July 19, 2019 and 2019-07-19T20:00:00Z for 8:00 PM July 19, 2019.

    • KpiName — (String)

      The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.

    • NextToken — (String)

      The string that specifies which page of results to return in a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

    • PageSize — (String)

      The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

    • StartTime — (Date)

      The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format, for example: 2019-07-15T00:00:00Z for July 15, 2019 and 2019-07-15T16:00:00Z for 4:00 PM July 15, 2019.

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:

      • ApplicationDateRangeKpiResponse — (map)

        Provides the results of a query that retrieved the data for a standard metric that applies to an application, and provides information about that query.

        • ApplicationIdrequired — (String)

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

        • EndTimerequired — (Date)

          The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

        • KpiNamerequired — (String)

          The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.

        • KpiResultrequired — (map)

          An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.

          • Rowsrequired — (Array<map>)

            An array of objects that provides the results of a query that retrieved the data for a standard metric that applies to an application, campaign, or journey.

            • GroupedBysrequired — (Array<map>)

              An array of objects that defines the field and field values that were used to group data in a result set that contains multiple results. This value is null if the data in a result set isn’t grouped.

              • Keyrequired — (String)

                The friendly name of the metric whose value is specified by the Value property.

              • Typerequired — (String)

                The data type of the value specified by the Value property.

              • Valuerequired — (String)

                In a Values object, the value for the metric that the query retrieved data for. In a GroupedBys object, the value for the field that was used to group data in a result set that contains multiple results (Values objects).

            • Valuesrequired — (Array<map>)

              An array of objects that provides pre-aggregated values for a standard metric that applies to an application, campaign, or journey.

              • Keyrequired — (String)

                The friendly name of the metric whose value is specified by the Value property.

              • Typerequired — (String)

                The data type of the value specified by the Value property.

              • Valuerequired — (String)

                In a Values object, the value for the metric that the query retrieved data for. In a GroupedBys object, the value for the field that was used to group data in a result set that contains multiple results (Values objects).

        • NextToken — (String)

          The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Application Metrics resource because the resource returns all results in a single page.

        • StartTimerequired — (Date)

          The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

Returns:

  • (AWS.Request)

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

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

Retrieves information about the settings for an application.

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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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)

        Provides information about an application, including the default settings for an application.

        • ApplicationIdrequired — (String)

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

        • CampaignHook — (map)

          The settings for the AWS Lambda function to use by default as a code hook for campaigns in the application.

          • LambdaFunctionName — (String)

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

          • Mode — (String)

            Specifies which Lambda mode to use when invoking the AWS Lambda function.

            Possible values include:
            • "DELIVERY"
            • "FILTER"
          • WebUrl — (String)

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

        • LastModifiedDate — (String)

          The date and time, in ISO 8601 format, when the application's settings were last modified.

        • Limits — (map)

          The default sending limits for campaigns in the application.

          • Daily — (Integer)

            The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. The maximum value is 100.

          • MaximumDuration — (Integer)

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

          • MessagesPerSecond — (Integer)

            The maximum number of messages that a campaign can send each second. The minimum value is 50. The maximum value is 20,000.

          • Total — (Integer)

            The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. The maximum value is 100.

        • QuietTime — (map)

          The default quiet time for campaigns and journeys in the application. Quiet time is a specific time range when messages aren't sent to endpoints, if all the following conditions are met:

          • The EndpointDemographic.Timezone property of the endpoint is set to a valid value.

          • The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application (or a campaign or journey that has custom quiet time settings).

          • The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application (or a campaign or journey that has custom quiet time settings).

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

          • End — (String)

            The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

          • Start — (String)

            The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

Returns:

  • (AWS.Request)

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

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

Retrieves information about all of your applications.

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 maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

    • Token — (String)

      The NextToken string that specifies which page of results to return 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)

        Provides information about all of your applications.

        • Item — (Array<map>)

          An array of responses, one for each application that was returned.

          • Arnrequired — (String)

            The Amazon Resource Name (ARN) of the application.

          • Idrequired — (String)

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

          • Namerequired — (String)

            The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console.

          • tags — (map<String>)

            A string-to-string map of key-value pairs that identifies the tags that are associated with the application. Each tag consists of a required tag key and an associated tag value.

        • NextToken — (String)

          The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

Returns:

  • (AWS.Request)

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

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

Retrieves information about the status and settings of the Baidu channel for an application.

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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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)

        Provides information about the status and settings of the Baidu (Baidu Cloud Push) channel for an application.

        • ApplicationId — (String)

          The unique identifier for the application that the Baidu channel applies to.

        • CreationDate — (String)

          The date and time when the Baidu channel was enabled.

        • Credentialrequired — (String)

          The API key that you received from the Baidu Cloud Push service to communicate with the service.

        • Enabled — (Boolean)

          Specifies whether the Baidu channel is enabled for the application.

        • HasCredential — (Boolean)

          (Not used) This property is retained only for backward compatibility.

        • Id — (String)

          (Deprecated) An identifier for the Baidu channel. This property is retained only for backward compatibility.

        • IsArchived — (Boolean)

          Specifies whether the Baidu channel is archived.

        • LastModifiedBy — (String)

          The user who last modified the Baidu channel.

        • LastModifiedDate — (String)

          The date and time when the Baidu channel was last modified.

        • Platformrequired — (String)

          The type of messaging or notification platform for the channel. For the Baidu channel, this value is BAIDU.

        • Version — (Integer)

          The current version of the Baidu channel.

Returns:

  • (AWS.Request)

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

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

Retrieves information about the status, configuration, and other settings for 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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    • CampaignId — (String)

      The unique identifier for 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)

        Provides information about the status, configuration, and other settings for a campaign.

        • AdditionalTreatments — (Array<map>)

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

          • Idrequired — (String)

            The unique identifier for the treatment.

          • MessageConfiguration — (map)

            The message configuration settings for the treatment.

            • ADMMessage — (map)

              The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.

              • Action — (String)

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

                • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

                • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

                • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

                Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • Body — (String)

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

              • ImageIconUrl — (String)

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

              • ImageSmallIconUrl — (String)

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

              • ImageUrl — (String)

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

              • JsonBody — (String)

                The JSON payload to use for a silent push notification.

              • MediaUrl — (String)

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

              • RawContent — (String)

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

              • SilentPush — (Boolean)

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

              • TimeToLive — (Integer)

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

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

              • Title — (String)

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

              • Url — (String)

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

            • APNSMessage — (map)

              The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.

              • Action — (String)

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

                • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

                • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

                • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

                Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • Body — (String)

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

              • ImageIconUrl — (String)

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

              • ImageSmallIconUrl — (String)

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

              • ImageUrl — (String)

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

              • JsonBody — (String)

                The JSON payload to use for a silent push notification.

              • MediaUrl — (String)

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

              • RawContent — (String)

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

              • SilentPush — (Boolean)

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

              • TimeToLive — (Integer)

                The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

                This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

              • Title — (String)

                The title to display above the notification message on a recipient's device.

              • Url — (String)

                The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

            • BaiduMessage — (map)

              The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.

              • Action — (String)

                The action to occur if a recipient taps the push notification. Valid values are:

                • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

                • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

                • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

                Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • Body — (String)

                The body of the notification message. The maximum number of characters is 200.

              • ImageIconUrl — (String)

                The URL of the image to display as the push-notification icon, such as the icon for the app.

              • ImageSmallIconUrl — (String)

                The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

              • ImageUrl — (String)

                The URL of an image to display in the push notification.

              • JsonBody — (String)

                The JSON payload to use for a silent push notification.

              • MediaUrl — (String)

                The URL of the image or video to display in the push notification.

              • RawContent — (String)

                The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

              • SilentPush — (Boolean)

                Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

              • TimeToLive — (Integer)

                The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

                This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

              • Title — (String)

                The title to display above the notification message on a recipient's device.

              • Url — (String)

                The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

            • DefaultMessage — (map)

              The default message that the campaign sends through all the channels that are configured for the campaign.

              • Action — (String)

                The action to occur if a recipient taps the push notification. Valid values are:

                • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

                • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

                • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

                Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • Body — (String)

                The body of the notification message. The maximum number of characters is 200.

              • ImageIconUrl — (String)

                The URL of the image to display as the push-notification icon, such as the icon for the app.

              • ImageSmallIconUrl — (String)

                The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

              • ImageUrl — (String)

                The URL of an image to display in the push notification.

              • JsonBody — (String)

                The JSON payload to use for a silent push notification.

              • MediaUrl — (String)

                The URL of the image or video to display in the push notification.

              • RawContent — (String)

                The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

              • SilentPush — (Boolean)

                Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

              • TimeToLive — (Integer)

                The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

                This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

              • Title — (String)

                The title to display above the notification message on a recipient's device.

              • Url — (String)

                The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

            • EmailMessage — (map)

              The message that the campaign sends through the email channel.

              • Body — (String)

                The body of the email for recipients whose email clients don't render HTML content.

              • FromAddress — (String)

                The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.

              • HtmlBody — (String)

                The body of the email, in HTML format, for recipients whose email clients render HTML content.

              • Titlerequired — (String)

                The subject line, or title, of the email.

            • GCMMessage — (map)

              The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default message.

              • Action — (String)

                The action to occur if a recipient taps the push notification. Valid values are:

                • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

                • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

                • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

                Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • Body — (String)

                The body of the notification message. The maximum number of characters is 200.

              • ImageIconUrl — (String)

                The URL of the image to display as the push-notification icon, such as the icon for the app.

              • ImageSmallIconUrl — (String)

                The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

              • ImageUrl — (String)

                The URL of an image to display in the push notification.

              • JsonBody — (String)

                The JSON payload to use for a silent push notification.

              • MediaUrl — (String)

                The URL of the image or video to display in the push notification.

              • RawContent — (String)

                The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

              • SilentPush — (Boolean)

                Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

              • TimeToLive — (Integer)

                The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

                This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

              • Title — (String)

                The title to display above the notification message on a recipient's device.

              • Url — (String)

                The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

            • SMSMessage — (map)

              The message that the campaign sends through the SMS channel.

              • Body — (String)

                The body of the SMS message.

              • MessageType — (String)

                The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.

                Possible values include:
                • "TRANSACTIONAL"
                • "PROMOTIONAL"
              • SenderId — (String)

                The sender ID to display on recipients' devices when they receive the SMS message.

          • Schedule — (map)

            The schedule settings for the treatment.

            • EndTime — (String)

              The scheduled time, in ISO 8601 format, when the campaign ended or will end.

            • EventFilter — (map)

              The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.

              • Dimensionsrequired — (map)

                The dimension settings of the event filter for the campaign.

                • Attributes — (map<map>)

                  One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.

                  • AttributeType — (String)

                    The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                    Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Valuesrequired — (Array<String>)

                    The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

                • EventType — (map)

                  The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard type of event that Amazon Pinpoint generates, such as _email.delivered, or a custom event that's specific to your application.

                  • DimensionType — (String)

                    The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                    Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Valuesrequired — (Array<String>)

                    The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                • Metrics — (map<map>)

                  One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.

                  • ComparisonOperatorrequired — (String)

                    The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.

                  • Valuerequired — (Float)

                    The value to compare.

              • FilterTyperequired — (String)

                The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Events resource) occurs.

                Possible values include:
                • "SYSTEM"
                • "ENDPOINT"
            • Frequency — (String)

              Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.

              Possible values include:
              • "ONCE"
              • "HOURLY"
              • "DAILY"
              • "WEEKLY"
              • "MONTHLY"
              • "EVENT"
            • IsLocalTime — (Boolean)

              Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.

            • QuietTime — (map)

              The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:

              • The EndpointDemographic.Timezone property of the endpoint is set to a valid value.

              • The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.

              • The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.

              If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.

              • End — (String)

                The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

              • Start — (String)

                The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

            • StartTimerequired — (String)

              The scheduled time, in ISO 8601 format, when the campaign began or will begin.

            • Timezone — (String)

              The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.

          • SizePercentrequired — (Integer)

            The allocated percentage of users (segment members) that the treatment is sent to.

          • State — (map)

            The current status of the treatment.

            • CampaignStatus — (String)

              The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED.

              Possible values include:
              • "SCHEDULED"
              • "EXECUTING"
              • "PENDING_NEXT_RUN"
              • "COMPLETED"
              • "PAUSED"
              • "DELETED"
          • TemplateConfiguration — (map)

            The message template to use for the treatment.

            • EmailTemplate — (map)

              The email template to use for the message.

              • Name — (String)

                The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

            • PushTemplate — (map)

              The push notification template to use for the message.

              • Name — (String)

                The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

            • SMSTemplate — (map)

              The SMS template to use for the message.

              • Name — (String)

                The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

            • VoiceTemplate — (map)

              The voice template to use for the message.

              • Name — (String)

                The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

          • TreatmentDescription — (String)

            The custom description of the treatment.

          • TreatmentName — (String)

            The custom name of the treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.

        • ApplicationIdrequired — (String)

          The unique identifier for the application that the campaign applies to.

        • Arnrequired — (String)

          The Amazon Resource Name (ARN) of the campaign.

        • CreationDaterequired — (String)

          The date, ISO 8601 format, when the campaign was created.

        • DefaultState — (map)

          The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment, to support A/B testing.

          • CampaignStatus — (String)

            The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED.

            Possible values include:
            • "SCHEDULED"
            • "EXECUTING"
            • "PENDING_NEXT_RUN"
            • "COMPLETED"
            • "PAUSED"
            • "DELETED"
        • Description — (String)

          The custom description of the campaign.

        • HoldoutPercent — (Integer)

          The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.

        • Hook — (map)

          The settings for the AWS Lambda function to use as a code hook for the campaign.

          • LambdaFunctionName — (String)

            The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to send messages for a campaign.

          • Mode — (String)

            Specifies which Lambda mode to use when invoking the AWS Lambda function.

            Possible values include:
            • "DELIVERY"
            • "FILTER"
          • WebUrl — (String)

            The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.

        • Idrequired — (String)

          The unique identifier for the campaign.

        • IsPaused — (Boolean)

          Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.

        • LastModifiedDaterequired — (String)

          The date, in ISO 8601 format, when the campaign was last modified.

        • Limits — (map)

          The messaging limits for the campaign.

          • Daily — (Integer)

            The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. The maximum value is 100.

          • MaximumDuration — (Integer)

            The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.

          • MessagesPerSecond — (Integer)

            The maximum number of messages that a campaign can send each second. The minimum value is 50. The maximum value is 20,000.

          • Total — (Integer)

            The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. The maximum value is 100.

        • MessageConfiguration — (map)

          The message configuration settings for the campaign.

          • ADMMessage — (map)

            The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.

            • Action — (String)

              The action to occur if a recipient taps the push notification. Valid values are:

              • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

              • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

              • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

              Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • Body — (String)

              The body of the notification message. The maximum number of characters is 200.

            • ImageIconUrl — (String)

              The URL of the image to display as the push-notification icon, such as the icon for the app.

            • ImageSmallIconUrl — (String)

              The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

            • ImageUrl — (String)

              The URL of an image to display in the push notification.

            • JsonBody — (String)

              The JSON payload to use for a silent push notification.

            • MediaUrl — (String)

              The URL of the image or video to display in the push notification.

            • RawContent — (String)

              The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

            • SilentPush — (Boolean)

              Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

            • TimeToLive — (Integer)

              The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

              This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

            • Title — (String)

              The title to display above the notification message on a recipient's device.

            • Url — (String)

              The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

          • APNSMessage — (map)

            The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.

            • Action — (String)

              The action to occur if a recipient taps the push notification. Valid values are:

              • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

              • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

              • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

              Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • Body — (String)

              The body of the notification message. The maximum number of characters is 200.

            • ImageIconUrl — (String)

              The URL of the image to display as the push-notification icon, such as the icon for the app.

            • ImageSmallIconUrl — (String)

              The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

            • ImageUrl — (String)

              The URL of an image to display in the push notification.

            • JsonBody — (String)

              The JSON payload to use for a silent push notification.

            • MediaUrl — (String)

              The URL of the image or video to display in the push notification.

            • RawContent — (String)

              The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

            • SilentPush — (Boolean)

              Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

            • TimeToLive — (Integer)

              The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

              This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

            • Title — (String)

              The title to display above the notification message on a recipient's device.

            • Url — (String)

              The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

          • BaiduMessage — (map)

            The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.

            • Action — (String)

              The action to occur if a recipient taps the push notification. Valid values are:

              • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

              • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

              • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

              Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • Body — (String)

              The body of the notification message. The maximum number of characters is 200.

            • ImageIconUrl — (String)

              The URL of the image to display as the push-notification icon, such as the icon for the app.

            • ImageSmallIconUrl — (String)

              The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

            • ImageUrl — (String)

              The URL of an image to display in the push notification.

            • JsonBody — (String)

              The JSON payload to use for a silent push notification.

            • MediaUrl — (String)

              The URL of the image or video to display in the push notification.

            • RawContent — (String)

              The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

            • SilentPush — (Boolean)

              Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

            • TimeToLive — (Integer)

              The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

              This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

            • Title — (String)

              The title to display above the notification message on a recipient's device.

            • Url — (String)

              The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

          • DefaultMessage — (map)

            The default message that the campaign sends through all the channels that are configured for the campaign.

            • Action — (String)

              The action to occur if a recipient taps the push notification. Valid values are:

              • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

              • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

              • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

              Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • Body — (String)

              The body of the notification message. The maximum number of characters is 200.

            • ImageIconUrl — (String)

              The URL of the image to display as the push-notification icon, such as the icon for the app.

            • ImageSmallIconUrl — (String)

              The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

            • ImageUrl — (String)

              The URL of an image to display in the push notification.

            • JsonBody — (String)

              The JSON payload to use for a silent push notification.

            • MediaUrl — (String)

              The URL of the image or video to display in the push notification.

            • RawContent — (String)

              The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

            • SilentPush — (Boolean)

              Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

            • TimeToLive — (Integer)

              The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

              This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

            • Title — (String)

              The title to display above the notification message on a recipient's device.

            • Url — (String)

              The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

          • EmailMessage — (map)

            The message that the campaign sends through the email channel.

            • Body — (String)

              The body of the email for recipients whose email clients don't render HTML content.

            • FromAddress — (String)

              The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.

            • HtmlBody — (String)

              The body of the email, in HTML format, for recipients whose email clients render HTML content.

            • Titlerequired — (String)

              The subject line, or title, of the email.

          • GCMMessage — (map)

            The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default message.

            • Action — (String)

              The action to occur if a recipient taps the push notification. Valid values are:

              • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

              • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

              • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

              Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • Body — (String)

              The body of the notification message. The maximum number of characters is 200.

            • ImageIconUrl — (String)

              The URL of the image to display as the push-notification icon, such as the icon for the app.

            • ImageSmallIconUrl — (String)

              The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

            • ImageUrl — (String)

              The URL of an image to display in the push notification.

            • JsonBody — (String)

              The JSON payload to use for a silent push notification.

            • MediaUrl — (String)

              The URL of the image or video to display in the push notification.

            • RawContent — (String)

              The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

            • SilentPush — (Boolean)

              Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

            • TimeToLive — (Integer)

              The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

              This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

            • Title — (String)

              The title to display above the notification message on a recipient's device.

            • Url — (String)

              The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

          • SMSMessage — (map)

            The message that the campaign sends through the SMS channel.

            • Body — (String)

              The body of the SMS message.

            • MessageType — (String)

              The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.

              Possible values include:
              • "TRANSACTIONAL"
              • "PROMOTIONAL"
            • SenderId — (String)

              The sender ID to display on recipients' devices when they receive the SMS message.

        • Name — (String)

          The name of the campaign.

        • Schedule — (map)

          The schedule settings for the campaign.

          • EndTime — (String)

            The scheduled time, in ISO 8601 format, when the campaign ended or will end.

          • EventFilter — (map)

            The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.

            • Dimensionsrequired — (map)

              The dimension settings of the event filter for the campaign.

              • Attributes — (map<map>)

                One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.

                • AttributeType — (String)

                  The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                  Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Valuesrequired — (Array<String>)

                  The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

              • EventType — (map)

                The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard type of event that Amazon Pinpoint generates, such as _email.delivered, or a custom event that's specific to your application.

                • DimensionType — (String)

                  The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                  Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Valuesrequired — (Array<String>)

                  The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

              • Metrics — (map<map>)

                One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.

                • ComparisonOperatorrequired — (String)

                  The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.

                • Valuerequired — (Float)

                  The value to compare.

            • FilterTyperequired — (String)

              The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Events resource) occurs.

              Possible values include:
              • "SYSTEM"
              • "ENDPOINT"
          • Frequency — (String)

            Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.

            Possible values include:
            • "ONCE"
            • "HOURLY"
            • "DAILY"
            • "WEEKLY"
            • "MONTHLY"
            • "EVENT"
          • IsLocalTime — (Boolean)

            Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.

          • QuietTime — (map)

            The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:

            • The EndpointDemographic.Timezone property of the endpoint is set to a valid value.

            • The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.

            • The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.

            If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.

            • End — (String)

              The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

            • Start — (String)

              The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

          • StartTimerequired — (String)

            The scheduled time, in ISO 8601 format, when the campaign began or will begin.

          • Timezone — (String)

            The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.

        • SegmentIdrequired — (String)

          The unique identifier for the segment that's associated with the campaign.

        • SegmentVersionrequired — (Integer)

          The version number of the segment that's associated with the campaign.

        • State — (map)

          The current status of the campaign.

          • CampaignStatus — (String)

            The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED.

            Possible values include:
            • "SCHEDULED"
            • "EXECUTING"
            • "PENDING_NEXT_RUN"
            • "COMPLETED"
            • "PAUSED"
            • "DELETED"
        • tags — (map<String>)

          A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.

        • TemplateConfiguration — (map)

          The message template that’s used for the campaign.

          • EmailTemplate — (map)

            The email template to use for the message.

            • Name — (String)

              The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

          • PushTemplate — (map)

            The push notification template to use for the message.

            • Name — (String)

              The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

          • SMSTemplate — (map)

            The SMS template to use for the message.

            • Name — (String)

              The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

          • VoiceTemplate — (map)

            The voice template to use for the message.

            • Name — (String)

              The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

        • TreatmentDescription — (String)

          The custom description of a variation of the campaign that's used for A/B testing.

        • TreatmentName — (String)

          The custom name of a variation of the campaign that's used for A/B testing.

        • Version — (Integer)

          The version number of the campaign.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getCampaignActivities(params = {}, callback) ⇒ AWS.Request

Retrieves information about all the activities for 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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    • CampaignId — (String)

      The unique identifier for the campaign.

    • PageSize — (String)

      The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

    • Token — (String)

      The NextToken string that specifies which page of results to return 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)

        Provides information about the activities that were performed by a campaign.

        • Itemrequired — (Array<map>)

          An array of responses, one for each activity that was performed by the campaign.

          • ApplicationIdrequired — (String)

            The unique identifier for the application that the campaign applies to.

          • CampaignIdrequired — (String)

            The unique identifier for the campaign that the activity applies to.

          • End — (String)

            The actual time, in ISO 8601 format, when the activity was marked CANCELLED or COMPLETED.

          • Idrequired — (String)

            The unique identifier for the activity.

          • Result — (String)

            Specifies whether the activity succeeded. Possible values are SUCCESS and FAIL.

          • ScheduledStart — (String)

            The scheduled start time, in ISO 8601 format, for the activity.

          • Start — (String)

            The actual start time, in ISO 8601 format, of the activity.

          • State — (String)

            The current status of the activity. Possible values are: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, and COMPLETED.

          • SuccessfulEndpointCount — (Integer)

            The total number of endpoints that the campaign successfully delivered messages to.

          • TimezonesCompletedCount — (Integer)

            The total number of time zones that were completed.

          • TimezonesTotalCount — (Integer)

            The total number of unique time zones that are in the segment for the campaign.

          • TotalEndpointCount — (Integer)

            The total number of endpoints that the campaign attempted to deliver messages to.

          • TreatmentId — (String)

            The unique identifier for the campaign treatment that the activity applies to. A treatment is a variation of a campaign that's used for A/B testing of a campaign.

        • NextToken — (String)

          The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getCampaignDateRangeKpi(params = {}, callback) ⇒ AWS.Request

Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign.

Service Reference:

Examples:

Calling the getCampaignDateRangeKpi operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  CampaignId: 'STRING_VALUE', /* required */
  KpiName: 'STRING_VALUE', /* required */
  EndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  NextToken: 'STRING_VALUE',
  PageSize: 'STRING_VALUE',
  StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
pinpoint.getCampaignDateRangeKpi(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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    • CampaignId — (String)

      The unique identifier for the campaign.

    • EndTime — (Date)

      The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format, for example: 2019-07-19T00:00:00Z for July 19, 2019 and 2019-07-19T20:00:00Z for 8:00 PM July 19, 2019.

    • KpiName — (String)

      The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.

    • NextToken — (String)

      The string that specifies which page of results to return in a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

    • PageSize — (String)

      The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

    • StartTime — (Date)

      The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format, for example: 2019-07-15T00:00:00Z for July 15, 2019 and 2019-07-15T16:00:00Z for 4:00 PM July 15, 2019.

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:

      • CampaignDateRangeKpiResponse — (map)

        Provides the results of a query that retrieved the data for a standard metric that applies to a campaign, and provides information about that query.

        • ApplicationIdrequired — (String)

          The unique identifier for the application that the metric applies to.

        • CampaignIdrequired — (String)

          The unique identifier for the campaign that the metric applies to.

        • EndTimerequired — (Date)

          The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

        • KpiNamerequired — (String)

          The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.

        • KpiResultrequired — (map)

          An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.

          • Rowsrequired — (Array<map>)

            An array of objects that provides the results of a query that retrieved the data for a standard metric that applies to an application, campaign, or journey.

            • GroupedBysrequired — (Array<map>)

              An array of objects that defines the field and field values that were used to group data in a result set that contains multiple results. This value is null if the data in a result set isn’t grouped.

              • Keyrequired — (String)

                The friendly name of the metric whose value is specified by the Value property.

              • Typerequired — (String)

                The data type of the value specified by the Value property.

              • Valuerequired — (String)

                In a Values object, the value for the metric that the query retrieved data for. In a GroupedBys object, the value for the field that was used to group data in a result set that contains multiple results (Values objects).

            • Valuesrequired — (Array<map>)

              An array of objects that provides pre-aggregated values for a standard metric that applies to an application, campaign, or journey.

              • Keyrequired — (String)

                The friendly name of the metric whose value is specified by the Value property.

              • Typerequired — (String)

                The data type of the value specified by the Value property.

              • Valuerequired — (String)

                In a Values object, the value for the metric that the query retrieved data for. In a GroupedBys object, the value for the field that was used to group data in a result set that contains multiple results (Values objects).

        • NextToken — (String)

          The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Campaign Metrics resource because the resource returns all results in a single page.

        • StartTimerequired — (Date)

          The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getCampaigns(params = {}, callback) ⇒ AWS.Request

Retrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application.

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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    • PageSize — (String)

      The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

    • Token — (String)

      The NextToken string that specifies which page of results to return 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)

        Provides information about the configuration and other settings for all the campaigns that are associated with an application.

        • Itemrequired — (Array<map>)

          An array of responses, one for each campaign that's associated with the application.

          • AdditionalTreatments — (Array<map>)

            An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.

            • Idrequired — (String)

              The unique identifier for the treatment.

            • MessageConfiguration — (map)

              The message configuration settings for the treatment.

              • ADMMessage — (map)

                The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.

                • Action — (String)

                  The action to occur if a recipient taps the push notification. Valid values are:

                  • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

                  • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

                  • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

                  Possible values include:
                  • "OPEN_APP"
                  • "DEEP_LINK"
                  • "URL"
                • Body — (String)

                  The body of the notification message. The maximum number of characters is 200.

                • ImageIconUrl — (String)

                  The URL of the image to display as the push-notification icon, such as the icon for the app.

                • ImageSmallIconUrl — (String)

                  The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

                • ImageUrl — (String)

                  The URL of an image to display in the push notification.

                • JsonBody — (String)

                  The JSON payload to use for a silent push notification.

                • MediaUrl — (String)

                  The URL of the image or video to display in the push notification.

                • RawContent — (String)

                  The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

                • SilentPush — (Boolean)

                  Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

                • TimeToLive — (Integer)

                  The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

                  This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

                • Title — (String)

                  The title to display above the notification message on a recipient's device.

                • Url — (String)

                  The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

              • APNSMessage — (map)

                The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.

                • Action — (String)

                  The action to occur if a recipient taps the push notification. Valid values are:

                  • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

                  • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

                  • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

                  Possible values include:
                  • "OPEN_APP"
                  • "DEEP_LINK"
                  • "URL"
                • Body — (String)

                  The body of the notification message. The maximum number of characters is 200.

                • ImageIconUrl — (String)

                  The URL of the image to display as the push-notification icon, such as the icon for the app.

                • ImageSmallIconUrl — (String)

                  The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

                • ImageUrl — (String)

                  The URL of an image to display in the push notification.

                • JsonBody — (String)

                  The JSON payload to use for a silent push notification.

                • MediaUrl — (String)

                  The URL of the image or video to display in the push notification.

                • RawContent — (String)

                  The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

                • SilentPush — (Boolean)

                  Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

                • TimeToLive — (Integer)

                  The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

                  This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

                • Title — (String)

                  The title to display above the notification message on a recipient's device.

                • Url — (String)

                  The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

              • BaiduMessage — (map)

                The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.

                • Action — (String)

                  The action to occur if a recipient taps the push notification. Valid values are:

                  • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

                  • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

                  • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

                  Possible values include:
                  • "OPEN_APP"
                  • "DEEP_LINK"
                  • "URL"
                • Body — (String)

                  The body of the notification message. The maximum number of characters is 200.

                • ImageIconUrl — (String)

                  The URL of the image to display as the push-notification icon, such as the icon for the app.

                • ImageSmallIconUrl — (String)

                  The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

                • ImageUrl — (String)

                  The URL of an image to display in the push notification.

                • JsonBody — (String)

                  The JSON payload to use for a silent push notification.

                • MediaUrl — (String)

                  The URL of the image or video to display in the push notification.

                • RawContent — (String)

                  The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

                • SilentPush — (Boolean)

                  Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

                • TimeToLive — (Integer)

                  The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

                  This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

                • Title — (String)

                  The title to display above the notification message on a recipient's device.

                • Url — (String)

                  The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

              • DefaultMessage — (map)

                The default message that the campaign sends through all the channels that are configured for the campaign.

                • Action — (String)

                  The action to occur if a recipient taps the push notification. Valid values are:

                  • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

                  • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

                  • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

                  Possible values include:
                  • "OPEN_APP"
                  • "DEEP_LINK"
                  • "URL"
                • Body — (String)

                  The body of the notification message. The maximum number of characters is 200.

                • ImageIconUrl — (String)

                  The URL of the image to display as the push-notification icon, such as the icon for the app.

                • ImageSmallIconUrl — (String)

                  The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

                • ImageUrl — (String)

                  The URL of an image to display in the push notification.

                • JsonBody — (String)

                  The JSON payload to use for a silent push notification.

                • MediaUrl — (String)

                  The URL of the image or video to display in the push notification.

                • RawContent — (String)

                  The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

                • SilentPush — (Boolean)

                  Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

                • TimeToLive — (Integer)

                  The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

                  This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

                • Title — (String)

                  The title to display above the notification message on a recipient's device.

                • Url — (String)

                  The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

              • EmailMessage — (map)

                The message that the campaign sends through the email channel.

                • Body — (String)

                  The body of the email for recipients whose email clients don't render HTML content.

                • FromAddress — (String)

                  The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.

                • HtmlBody — (String)

                  The body of the email, in HTML format, for recipients whose email clients render HTML content.

                • Titlerequired — (String)

                  The subject line, or title, of the email.

              • GCMMessage — (map)

                The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default message.

                • Action — (String)

                  The action to occur if a recipient taps the push notification. Valid values are:

                  • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

                  • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

                  • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

                  Possible values include:
                  • "OPEN_APP"
                  • "DEEP_LINK"
                  • "URL"
                • Body — (String)

                  The body of the notification message. The maximum number of characters is 200.

                • ImageIconUrl — (String)

                  The URL of the image to display as the push-notification icon, such as the icon for the app.

                • ImageSmallIconUrl — (String)

                  The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

                • ImageUrl — (String)

                  The URL of an image to display in the push notification.

                • JsonBody — (String)

                  The JSON payload to use for a silent push notification.

                • MediaUrl — (String)

                  The URL of the image or video to display in the push notification.

                • RawContent — (String)

                  The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

                • SilentPush — (Boolean)

                  Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

                • TimeToLive — (Integer)

                  The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

                  This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

                • Title — (String)

                  The title to display above the notification message on a recipient's device.

                • Url — (String)

                  The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

              • SMSMessage — (map)

                The message that the campaign sends through the SMS channel.

                • Body — (String)

                  The body of the SMS message.

                • MessageType — (String)

                  The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.

                  Possible values include:
                  • "TRANSACTIONAL"
                  • "PROMOTIONAL"
                • SenderId — (String)

                  The sender ID to display on recipients' devices when they receive the SMS message.

            • Schedule — (map)

              The schedule settings for the treatment.

              • EndTime — (String)

                The scheduled time, in ISO 8601 format, when the campaign ended or will end.

              • EventFilter — (map)

                The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.

                • Dimensionsrequired — (map)

                  The dimension settings of the event filter for the campaign.

                  • Attributes — (map<map>)

                    One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.

                    • AttributeType — (String)

                      The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                      Possible values include:
                      • "INCLUSIVE"
                      • "EXCLUSIVE"
                    • Valuesrequired — (Array<String>)

                      The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

                  • EventType — (map)

                    The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard type of event that Amazon Pinpoint generates, such as _email.delivered, or a custom event that's specific to your application.

                    • DimensionType — (String)

                      The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                      Possible values include:
                      • "INCLUSIVE"
                      • "EXCLUSIVE"
                    • Valuesrequired — (Array<String>)

                      The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                  • Metrics — (map<map>)

                    One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.

                    • ComparisonOperatorrequired — (String)

                      The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.

                    • Valuerequired — (Float)

                      The value to compare.

                • FilterTyperequired — (String)

                  The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Events resource) occurs.

                  Possible values include:
                  • "SYSTEM"
                  • "ENDPOINT"
              • Frequency — (String)

                Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.

                Possible values include:
                • "ONCE"
                • "HOURLY"
                • "DAILY"
                • "WEEKLY"
                • "MONTHLY"
                • "EVENT"
              • IsLocalTime — (Boolean)

                Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.

              • QuietTime — (map)

                The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:

                • The EndpointDemographic.Timezone property of the endpoint is set to a valid value.

                • The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.

                • The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.

                If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.

                • End — (String)

                  The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

                • Start — (String)

                  The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

              • StartTimerequired — (String)

                The scheduled time, in ISO 8601 format, when the campaign began or will begin.

              • Timezone — (String)

                The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.

            • SizePercentrequired — (Integer)

              The allocated percentage of users (segment members) that the treatment is sent to.

            • State — (map)

              The current status of the treatment.

              • CampaignStatus — (String)

                The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED.

                Possible values include:
                • "SCHEDULED"
                • "EXECUTING"
                • "PENDING_NEXT_RUN"
                • "COMPLETED"
                • "PAUSED"
                • "DELETED"
            • TemplateConfiguration — (map)

              The message template to use for the treatment.

              • EmailTemplate — (map)

                The email template to use for the message.

                • Name — (String)

                  The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

              • PushTemplate — (map)

                The push notification template to use for the message.

                • Name — (String)

                  The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

              • SMSTemplate — (map)

                The SMS template to use for the message.

                • Name — (String)

                  The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

              • VoiceTemplate — (map)

                The voice template to use for the message.

                • Name — (String)

                  The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

            • TreatmentDescription — (String)

              The custom description of the treatment.

            • TreatmentName — (String)

              The custom name of the treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.

          • ApplicationIdrequired — (String)

            The unique identifier for the application that the campaign applies to.

          • Arnrequired — (String)

            The Amazon Resource Name (ARN) of the campaign.

          • CreationDaterequired — (String)

            The date, ISO 8601 format, when the campaign was created.

          • DefaultState — (map)

            The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment, to support A/B testing.

            • CampaignStatus — (String)

              The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED.

              Possible values include:
              • "SCHEDULED"
              • "EXECUTING"
              • "PENDING_NEXT_RUN"
              • "COMPLETED"
              • "PAUSED"
              • "DELETED"
          • Description — (String)

            The custom description of the campaign.

          • HoldoutPercent — (Integer)

            The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.

          • Hook — (map)

            The settings for the AWS Lambda function to use as a code hook for the campaign.

            • LambdaFunctionName — (String)

              The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to send messages for a campaign.

            • Mode — (String)

              Specifies which Lambda mode to use when invoking the AWS Lambda function.

              Possible values include:
              • "DELIVERY"
              • "FILTER"
            • WebUrl — (String)

              The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.

          • Idrequired — (String)

            The unique identifier for the campaign.

          • IsPaused — (Boolean)

            Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.

          • LastModifiedDaterequired — (String)

            The date, in ISO 8601 format, when the campaign was last modified.

          • Limits — (map)

            The messaging limits for the campaign.

            • Daily — (Integer)

              The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. The maximum value is 100.

            • MaximumDuration — (Integer)

              The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.

            • MessagesPerSecond — (Integer)

              The maximum number of messages that a campaign can send each second. The minimum value is 50. The maximum value is 20,000.

            • Total — (Integer)

              The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. The maximum value is 100.

          • MessageConfiguration — (map)

            The message configuration settings for the campaign.

            • ADMMessage — (map)

              The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.

              • Action — (String)

                The action to occur if a recipient taps the push notification. Valid values are:

                • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

                • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

                • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

                Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • Body — (String)

                The body of the notification message. The maximum number of characters is 200.

              • ImageIconUrl — (String)

                The URL of the image to display as the push-notification icon, such as the icon for the app.

              • ImageSmallIconUrl — (String)

                The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

              • ImageUrl — (String)

                The URL of an image to display in the push notification.

              • JsonBody — (String)

                The JSON payload to use for a silent push notification.

              • MediaUrl — (String)

                The URL of the image or video to display in the push notification.

              • RawContent — (String)

                The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

              • SilentPush — (Boolean)

                Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

              • TimeToLive — (Integer)

                The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

                This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

              • Title — (String)

                The title to display above the notification message on a recipient's device.

              • Url — (String)

                The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

            • APNSMessage — (map)

              The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.

              • Action — (String)

                The action to occur if a recipient taps the push notification. Valid values are:

                • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

                • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

                • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

                Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • Body — (String)

                The body of the notification message. The maximum number of characters is 200.

              • ImageIconUrl — (String)

                The URL of the image to display as the push-notification icon, such as the icon for the app.

              • ImageSmallIconUrl — (String)

                The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

              • ImageUrl — (String)

                The URL of an image to display in the push notification.

              • JsonBody — (String)

                The JSON payload to use for a silent push notification.

              • MediaUrl — (String)

                The URL of the image or video to display in the push notification.

              • RawContent — (String)

                The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

              • SilentPush — (Boolean)

                Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

              • TimeToLive — (Integer)

                The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

                This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

              • Title — (String)

                The title to display above the notification message on a recipient's device.

              • Url — (String)

                The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

            • BaiduMessage — (map)

              The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.

              • Action — (String)

                The action to occur if a recipient taps the push notification. Valid values are:

                • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

                • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

                • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

                Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • Body — (String)

                The body of the notification message. The maximum number of characters is 200.

              • ImageIconUrl — (String)

                The URL of the image to display as the push-notification icon, such as the icon for the app.

              • ImageSmallIconUrl — (String)

                The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

              • ImageUrl — (String)

                The URL of an image to display in the push notification.

              • JsonBody — (String)

                The JSON payload to use for a silent push notification.

              • MediaUrl — (String)

                The URL of the image or video to display in the push notification.

              • RawContent — (String)

                The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

              • SilentPush — (Boolean)

                Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

              • TimeToLive — (Integer)

                The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

                This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

              • Title — (String)

                The title to display above the notification message on a recipient's device.

              • Url — (String)

                The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

            • DefaultMessage — (map)

              The default message that the campaign sends through all the channels that are configured for the campaign.

              • Action — (String)

                The action to occur if a recipient taps the push notification. Valid values are:

                • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

                • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

                • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

                Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • Body — (String)

                The body of the notification message. The maximum number of characters is 200.

              • ImageIconUrl — (String)

                The URL of the image to display as the push-notification icon, such as the icon for the app.

              • ImageSmallIconUrl — (String)

                The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

              • ImageUrl — (String)

                The URL of an image to display in the push notification.

              • JsonBody — (String)

                The JSON payload to use for a silent push notification.

              • MediaUrl — (String)

                The URL of the image or video to display in the push notification.

              • RawContent — (String)

                The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

              • SilentPush — (Boolean)

                Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

              • TimeToLive — (Integer)

                The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

                This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

              • Title — (String)

                The title to display above the notification message on a recipient's device.

              • Url — (String)

                The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

            • EmailMessage — (map)

              The message that the campaign sends through the email channel.

              • Body — (String)

                The body of the email for recipients whose email clients don't render HTML content.

              • FromAddress — (String)

                The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.

              • HtmlBody — (String)

                The body of the email, in HTML format, for recipients whose email clients render HTML content.

              • Titlerequired — (String)

                The subject line, or title, of the email.

            • GCMMessage — (map)

              The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default message.

              • Action — (String)

                The action to occur if a recipient taps the push notification. Valid values are:

                • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

                • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

                • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

                Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • Body — (String)

                The body of the notification message. The maximum number of characters is 200.

              • ImageIconUrl — (String)

                The URL of the image to display as the push-notification icon, such as the icon for the app.

              • ImageSmallIconUrl — (String)

                The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

              • ImageUrl — (String)

                The URL of an image to display in the push notification.

              • JsonBody — (String)

                The JSON payload to use for a silent push notification.

              • MediaUrl — (String)

                The URL of the image or video to display in the push notification.

              • RawContent — (String)

                The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

              • SilentPush — (Boolean)

                Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

              • TimeToLive — (Integer)

                The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

                This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

              • Title — (String)

                The title to display above the notification message on a recipient's device.

              • Url — (String)

                The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

            • SMSMessage — (map)

              The message that the campaign sends through the SMS channel.

              • Body — (String)

                The body of the SMS message.

              • MessageType — (String)

                The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.

                Possible values include:
                • "TRANSACTIONAL"
                • "PROMOTIONAL"
              • SenderId — (String)

                The sender ID to display on recipients' devices when they receive the SMS message.

          • Name — (String)

            The name of the campaign.

          • Schedule — (map)

            The schedule settings for the campaign.

            • EndTime — (String)

              The scheduled time, in ISO 8601 format, when the campaign ended or will end.

            • EventFilter — (map)

              The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.

              • Dimensionsrequired — (map)

                The dimension settings of the event filter for the campaign.

                • Attributes — (map<map>)

                  One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.

                  • AttributeType — (String)

                    The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                    Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Valuesrequired — (Array<String>)

                    The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

                • EventType — (map)

                  The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard type of event that Amazon Pinpoint generates, such as _email.delivered, or a custom event that's specific to your application.

                  • DimensionType — (String)

                    The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                    Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Valuesrequired — (Array<String>)

                    The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                • Metrics — (map<map>)

                  One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.

                  • ComparisonOperatorrequired — (String)

                    The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.

                  • Valuerequired — (Float)

                    The value to compare.

              • FilterTyperequired — (String)

                The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Events resource) occurs.

                Possible values include:
                • "SYSTEM"
                • "ENDPOINT"
            • Frequency — (String)

              Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.

              Possible values include:
              • "ONCE"
              • "HOURLY"
              • "DAILY"
              • "WEEKLY"
              • "MONTHLY"
              • "EVENT"
            • IsLocalTime — (Boolean)

              Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.

            • QuietTime — (map)

              The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:

              • The EndpointDemographic.Timezone property of the endpoint is set to a valid value.

              • The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.

              • The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.

              If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.

              • End — (String)

                The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

              • Start — (String)

                The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

            • StartTimerequired — (String)

              The scheduled time, in ISO 8601 format, when the campaign began or will begin.

            • Timezone — (String)

              The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.

          • SegmentIdrequired — (String)

            The unique identifier for the segment that's associated with the campaign.

          • SegmentVersionrequired — (Integer)

            The version number of the segment that's associated with the campaign.

          • State — (map)

            The current status of the campaign.

            • CampaignStatus — (String)

              The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED.

              Possible values include:
              • "SCHEDULED"
              • "EXECUTING"
              • "PENDING_NEXT_RUN"
              • "COMPLETED"
              • "PAUSED"
              • "DELETED"
          • tags — (map<String>)

            A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.

          • TemplateConfiguration — (map)

            The message template that’s used for the campaign.

            • EmailTemplate — (map)

              The email template to use for the message.

              • Name — (String)

                The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

            • PushTemplate — (map)

              The push notification template to use for the message.

              • Name — (String)

                The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

            • SMSTemplate — (map)

              The SMS template to use for the message.

              • Name — (String)

                The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

            • VoiceTemplate — (map)

              The voice template to use for the message.

              • Name — (String)

                The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

          • TreatmentDescription — (String)

            The custom description of a variation of the campaign that's used for A/B testing.

          • TreatmentName — (String)

            The custom name of a variation of the campaign that's used for A/B testing.

          • Version — (Integer)

            The version number of the campaign.

        • NextToken — (String)

          The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getCampaignVersion(params = {}, callback) ⇒ AWS.Request

Retrieves information about the status, configuration, and other settings for 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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    • CampaignId — (String)

      The unique identifier for the campaign.

    • Version — (String)

      The unique version number (Version property) for the campaign 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:

      • CampaignResponse — (map)

        Provides information about the status, configuration, and other settings for a campaign.

        • AdditionalTreatments — (Array<map>)

          An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.

          • Idrequired — (String)

            The unique identifier for the treatment.

          • MessageConfiguration — (map)

            The message configuration settings for the treatment.

            • ADMMessage — (map)

              The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.

              • Action — (String)

                The action to occur if a recipient taps the push notification. Valid values are:

                • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

                • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

                • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

                Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • Body — (String)

                The body of the notification message. The maximum number of characters is 200.

              • ImageIconUrl — (String)

                The URL of the image to display as the push-notification icon, such as the icon for the app.

              • ImageSmallIconUrl — (String)

                The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

              • ImageUrl — (String)

                The URL of an image to display in the push notification.

              • JsonBody — (String)

                The JSON payload to use for a silent push notification.

              • MediaUrl — (String)

                The URL of the image or video to display in the push notification.

              • RawContent — (String)

                The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

              • SilentPush — (Boolean)

                Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

              • TimeToLive — (Integer)

                The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

                This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

              • Title — (String)

                The title to display above the notification message on a recipient's device.

              • Url — (String)

                The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

            • APNSMessage — (map)

              The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.

              • Action — (String)

                The action to occur if a recipient taps the push notification. Valid values are:

                • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

                • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

                • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

                Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • Body — (String)

                The body of the notification message. The maximum number of characters is 200.

              • ImageIconUrl — (String)

                The URL of the image to display as the push-notification icon, such as the icon for the app.

              • ImageSmallIconUrl — (String)

                The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

              • ImageUrl — (String)

                The URL of an image to display in the push notification.

              • JsonBody — (String)

                The JSON payload to use for a silent push notification.

              • MediaUrl — (String)

                The URL of the image or video to display in the push notification.

              • RawContent — (String)

                The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

              • SilentPush — (Boolean)

                Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

              • TimeToLive — (Integer)

                The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

                This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

              • Title — (String)

                The title to display above the notification message on a recipient's device.

              • Url — (String)

                The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

            • BaiduMessage — (map)

              The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.

              • Action — (String)

                The action to occur if a recipient taps the push notification. Valid values are:

                • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

                • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

                • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

                Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • Body — (String)

                The body of the notification message. The maximum number of characters is 200.

              • ImageIconUrl — (String)

                The URL of the image to display as the push-notification icon, such as the icon for the app.

              • ImageSmallIconUrl — (String)

                The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

              • ImageUrl — (String)

                The URL of an image to display in the push notification.

              • JsonBody — (String)

                The JSON payload to use for a silent push notification.

              • MediaUrl — (String)

                The URL of the image or video to display in the push notification.

              • RawContent — (String)

                The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

              • SilentPush — (Boolean)

                Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

              • TimeToLive — (Integer)

                The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

                This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

              • Title — (String)

                The title to display above the notification message on a recipient's device.

              • Url — (String)

                The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

            • DefaultMessage — (map)

              The default message that the campaign sends through all the channels that are configured for the campaign.

              • Action — (String)

                The action to occur if a recipient taps the push notification. Valid values are:

                • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

                • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

                • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

                Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • Body — (String)

                The body of the notification message. The maximum number of characters is 200.

              • ImageIconUrl — (String)

                The URL of the image to display as the push-notification icon, such as the icon for the app.

              • ImageSmallIconUrl — (String)

                The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

              • ImageUrl — (String)

                The URL of an image to display in the push notification.

              • JsonBody — (String)

                The JSON payload to use for a silent push notification.

              • MediaUrl — (String)

                The URL of the image or video to display in the push notification.

              • RawContent — (String)

                The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

              • SilentPush — (Boolean)

                Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

              • TimeToLive — (Integer)

                The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

                This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

              • Title — (String)

                The title to display above the notification message on a recipient's device.

              • Url — (String)

                The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

            • EmailMessage — (map)

              The message that the campaign sends through the email channel.

              • Body — (String)

                The body of the email for recipients whose email clients don't render HTML content.

              • FromAddress — (String)

                The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.

              • HtmlBody — (String)

                The body of the email, in HTML format, for recipients whose email clients render HTML content.

              • Titlerequired — (String)

                The subject line, or title, of the email.

            • GCMMessage — (map)

              The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default message.

              • Action — (String)

                The action to occur if a recipient taps the push notification. Valid values are:

                • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

                • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

                • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

                Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • Body — (String)

                The body of the notification message. The maximum number of characters is 200.

              • ImageIconUrl — (String)

                The URL of the image to display as the push-notification icon, such as the icon for the app.

              • ImageSmallIconUrl — (String)

                The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

              • ImageUrl — (String)

                The URL of an image to display in the push notification.

              • JsonBody — (String)

                The JSON payload to use for a silent push notification.

              • MediaUrl — (String)

                The URL of the image or video to display in the push notification.

              • RawContent — (String)

                The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

              • SilentPush — (Boolean)

                Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

              • TimeToLive — (Integer)

                The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

                This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

              • Title — (String)

                The title to display above the notification message on a recipient's device.

              • Url — (String)

                The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

            • SMSMessage — (map)

              The message that the campaign sends through the SMS channel.

              • Body — (String)

                The body of the SMS message.

              • MessageType — (String)

                The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.

                Possible values include:
                • "TRANSACTIONAL"
                • "PROMOTIONAL"
              • SenderId — (String)

                The sender ID to display on recipients' devices when they receive the SMS message.

          • Schedule — (map)

            The schedule settings for the treatment.

            • EndTime — (String)

              The scheduled time, in ISO 8601 format, when the campaign ended or will end.

            • EventFilter — (map)

              The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.

              • Dimensionsrequired — (map)

                The dimension settings of the event filter for the campaign.

                • Attributes — (map<map>)

                  One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.

                  • AttributeType — (String)

                    The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                    Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Valuesrequired — (Array<String>)

                    The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

                • EventType — (map)

                  The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard type of event that Amazon Pinpoint generates, such as _email.delivered, or a custom event that's specific to your application.

                  • DimensionType — (String)

                    The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                    Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Valuesrequired — (Array<String>)

                    The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                • Metrics — (map<map>)

                  One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.

                  • ComparisonOperatorrequired — (String)

                    The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.

                  • Valuerequired — (Float)

                    The value to compare.

              • FilterTyperequired — (String)

                The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Events resource) occurs.

                Possible values include:
                • "SYSTEM"
                • "ENDPOINT"
            • Frequency — (String)

              Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.

              Possible values include:
              • "ONCE"
              • "HOURLY"
              • "DAILY"
              • "WEEKLY"
              • "MONTHLY"
              • "EVENT"
            • IsLocalTime — (Boolean)

              Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.

            • QuietTime — (map)

              The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:

              • The EndpointDemographic.Timezone property of the endpoint is set to a valid value.

              • The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.

              • The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.

              If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.

              • End — (String)

                The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

              • Start — (String)

                The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

            • StartTimerequired — (String)

              The scheduled time, in ISO 8601 format, when the campaign began or will begin.

            • Timezone — (String)

              The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.

          • SizePercentrequired — (Integer)

            The allocated percentage of users (segment members) that the treatment is sent to.

          • State — (map)

            The current status of the treatment.

            • CampaignStatus — (String)

              The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED.

              Possible values include:
              • "SCHEDULED"
              • "EXECUTING"
              • "PENDING_NEXT_RUN"
              • "COMPLETED"
              • "PAUSED"
              • "DELETED"
          • TemplateConfiguration — (map)

            The message template to use for the treatment.

            • EmailTemplate — (map)

              The email template to use for the message.

              • Name — (String)

                The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

            • PushTemplate — (map)

              The push notification template to use for the message.

              • Name — (String)

                The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

            • SMSTemplate — (map)

              The SMS template to use for the message.

              • Name — (String)

                The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

            • VoiceTemplate — (map)

              The voice template to use for the message.

              • Name — (String)

                The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

          • TreatmentDescription — (String)

            The custom description of the treatment.

          • TreatmentName — (String)

            The custom name of the treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.

        • ApplicationIdrequired — (String)

          The unique identifier for the application that the campaign applies to.

        • Arnrequired — (String)

          The Amazon Resource Name (ARN) of the campaign.

        • CreationDaterequired — (String)

          The date, ISO 8601 format, when the campaign was created.

        • DefaultState — (map)

          The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment, to support A/B testing.

          • CampaignStatus — (String)

            The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED.

            Possible values include:
            • "SCHEDULED"
            • "EXECUTING"
            • "PENDING_NEXT_RUN"
            • "COMPLETED"
            • "PAUSED"
            • "DELETED"
        • Description — (String)

          The custom description of the campaign.

        • HoldoutPercent — (Integer)

          The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.

        • Hook — (map)

          The settings for the AWS Lambda function to use as a code hook for the campaign.

          • LambdaFunctionName — (String)

            The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to send messages for a campaign.

          • Mode — (String)

            Specifies which Lambda mode to use when invoking the AWS Lambda function.

            Possible values include:
            • "DELIVERY"
            • "FILTER"
          • WebUrl — (String)

            The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.

        • Idrequired — (String)

          The unique identifier for the campaign.

        • IsPaused — (Boolean)

          Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.

        • LastModifiedDaterequired — (String)

          The date, in ISO 8601 format, when the campaign was last modified.

        • Limits — (map)

          The messaging limits for the campaign.

          • Daily — (Integer)

            The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. The maximum value is 100.

          • MaximumDuration — (Integer)

            The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.

          • MessagesPerSecond — (Integer)

            The maximum number of messages that a campaign can send each second. The minimum value is 50. The maximum value is 20,000.

          • Total — (Integer)

            The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. The maximum value is 100.

        • MessageConfiguration — (map)

          The message configuration settings for the campaign.

          • ADMMessage — (map)

            The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.

            • Action — (String)

              The action to occur if a recipient taps the push notification. Valid values are:

              • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

              • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

              • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

              Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • Body — (String)

              The body of the notification message. The maximum number of characters is 200.

            • ImageIconUrl — (String)

              The URL of the image to display as the push-notification icon, such as the icon for the app.

            • ImageSmallIconUrl — (String)

              The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

            • ImageUrl — (String)

              The URL of an image to display in the push notification.

            • JsonBody — (String)

              The JSON payload to use for a silent push notification.

            • MediaUrl — (String)

              The URL of the image or video to display in the push notification.

            • RawContent — (String)

              The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

            • SilentPush — (Boolean)

              Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

            • TimeToLive — (Integer)

              The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

              This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

            • Title — (String)

              The title to display above the notification message on a recipient's device.

            • Url — (String)

              The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

          • APNSMessage — (map)

            The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.

            • Action — (String)

              The action to occur if a recipient taps the push notification. Valid values are:

              • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

              • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

              • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

              Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • Body — (String)

              The body of the notification message. The maximum number of characters is 200.

            • ImageIconUrl — (String)

              The URL of the image to display as the push-notification icon, such as the icon for the app.

            • ImageSmallIconUrl — (String)

              The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

            • ImageUrl — (String)

              The URL of an image to display in the push notification.

            • JsonBody — (String)

              The JSON payload to use for a silent push notification.

            • MediaUrl — (String)

              The URL of the image or video to display in the push notification.

            • RawContent — (String)

              The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

            • SilentPush — (Boolean)

              Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

            • TimeToLive — (Integer)

              The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

              This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

            • Title — (String)

              The title to display above the notification message on a recipient's device.

            • Url — (String)

              The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

          • BaiduMessage — (map)

            The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.

            • Action — (String)

              The action to occur if a recipient taps the push notification. Valid values are:

              • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

              • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

              • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

              Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • Body — (String)

              The body of the notification message. The maximum number of characters is 200.

            • ImageIconUrl — (String)

              The URL of the image to display as the push-notification icon, such as the icon for the app.

            • ImageSmallIconUrl — (String)

              The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

            • ImageUrl — (String)

              The URL of an image to display in the push notification.

            • JsonBody — (String)

              The JSON payload to use for a silent push notification.

            • MediaUrl — (String)

              The URL of the image or video to display in the push notification.

            • RawContent — (String)

              The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

            • SilentPush — (Boolean)

              Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

            • TimeToLive — (Integer)

              The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

              This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

            • Title — (String)

              The title to display above the notification message on a recipient's device.

            • Url — (String)

              The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

          • DefaultMessage — (map)

            The default message that the campaign sends through all the channels that are configured for the campaign.

            • Action — (String)

              The action to occur if a recipient taps the push notification. Valid values are:

              • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

              • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

              • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

              Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • Body — (String)

              The body of the notification message. The maximum number of characters is 200.

            • ImageIconUrl — (String)

              The URL of the image to display as the push-notification icon, such as the icon for the app.

            • ImageSmallIconUrl — (String)

              The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

            • ImageUrl — (String)

              The URL of an image to display in the push notification.

            • JsonBody — (String)

              The JSON payload to use for a silent push notification.

            • MediaUrl — (String)

              The URL of the image or video to display in the push notification.

            • RawContent — (String)

              The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

            • SilentPush — (Boolean)

              Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

            • TimeToLive — (Integer)

              The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

              This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

            • Title — (String)

              The title to display above the notification message on a recipient's device.

            • Url — (String)

              The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

          • EmailMessage — (map)

            The message that the campaign sends through the email channel.

            • Body — (String)

              The body of the email for recipients whose email clients don't render HTML content.

            • FromAddress — (String)

              The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.

            • HtmlBody — (String)

              The body of the email, in HTML format, for recipients whose email clients render HTML content.

            • Titlerequired — (String)

              The subject line, or title, of the email.

          • GCMMessage — (map)

            The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default message.

            • Action — (String)

              The action to occur if a recipient taps the push notification. Valid values are:

              • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

              • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

              • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

              Possible values include:
              • "OPEN_APP"
              • "DEEP_LINK"
              • "URL"
            • Body — (String)

              The body of the notification message. The maximum number of characters is 200.

            • ImageIconUrl — (String)

              The URL of the image to display as the push-notification icon, such as the icon for the app.

            • ImageSmallIconUrl — (String)

              The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

            • ImageUrl — (String)

              The URL of an image to display in the push notification.

            • JsonBody — (String)

              The JSON payload to use for a silent push notification.

            • MediaUrl — (String)

              The URL of the image or video to display in the push notification.

            • RawContent — (String)

              The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

            • SilentPush — (Boolean)

              Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

            • TimeToLive — (Integer)

              The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

              This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

            • Title — (String)

              The title to display above the notification message on a recipient's device.

            • Url — (String)

              The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

          • SMSMessage — (map)

            The message that the campaign sends through the SMS channel.

            • Body — (String)

              The body of the SMS message.

            • MessageType — (String)

              The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.

              Possible values include:
              • "TRANSACTIONAL"
              • "PROMOTIONAL"
            • SenderId — (String)

              The sender ID to display on recipients' devices when they receive the SMS message.

        • Name — (String)

          The name of the campaign.

        • Schedule — (map)

          The schedule settings for the campaign.

          • EndTime — (String)

            The scheduled time, in ISO 8601 format, when the campaign ended or will end.

          • EventFilter — (map)

            The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.

            • Dimensionsrequired — (map)

              The dimension settings of the event filter for the campaign.

              • Attributes — (map<map>)

                One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.

                • AttributeType — (String)

                  The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                  Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Valuesrequired — (Array<String>)

                  The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

              • EventType — (map)

                The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard type of event that Amazon Pinpoint generates, such as _email.delivered, or a custom event that's specific to your application.

                • DimensionType — (String)

                  The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                  Possible values include:
                  • "INCLUSIVE"
                  • "EXCLUSIVE"
                • Valuesrequired — (Array<String>)

                  The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

              • Metrics — (map<map>)

                One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.

                • ComparisonOperatorrequired — (String)

                  The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.

                • Valuerequired — (Float)

                  The value to compare.

            • FilterTyperequired — (String)

              The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Events resource) occurs.

              Possible values include:
              • "SYSTEM"
              • "ENDPOINT"
          • Frequency — (String)

            Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.

            Possible values include:
            • "ONCE"
            • "HOURLY"
            • "DAILY"
            • "WEEKLY"
            • "MONTHLY"
            • "EVENT"
          • IsLocalTime — (Boolean)

            Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.

          • QuietTime — (map)

            The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:

            • The EndpointDemographic.Timezone property of the endpoint is set to a valid value.

            • The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.

            • The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.

            If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.

            • End — (String)

              The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

            • Start — (String)

              The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

          • StartTimerequired — (String)

            The scheduled time, in ISO 8601 format, when the campaign began or will begin.

          • Timezone — (String)

            The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.

        • SegmentIdrequired — (String)

          The unique identifier for the segment that's associated with the campaign.

        • SegmentVersionrequired — (Integer)

          The version number of the segment that's associated with the campaign.

        • State — (map)

          The current status of the campaign.

          • CampaignStatus — (String)

            The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED.

            Possible values include:
            • "SCHEDULED"
            • "EXECUTING"
            • "PENDING_NEXT_RUN"
            • "COMPLETED"
            • "PAUSED"
            • "DELETED"
        • tags — (map<String>)

          A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.

        • TemplateConfiguration — (map)

          The message template that’s used for the campaign.

          • EmailTemplate — (map)

            The email template to use for the message.

            • Name — (String)

              The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

          • PushTemplate — (map)

            The push notification template to use for the message.

            • Name — (String)

              The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

          • SMSTemplate — (map)

            The SMS template to use for the message.

            • Name — (String)

              The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

          • VoiceTemplate — (map)

            The voice template to use for the message.

            • Name — (String)

              The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

        • TreatmentDescription — (String)

          The custom description of a variation of the campaign that's used for A/B testing.

        • TreatmentName — (String)

          The custom name of a variation of the campaign that's used for A/B testing.

        • Version — (Integer)

          The version number of the campaign.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getCampaignVersions(params = {}, callback) ⇒ AWS.Request

Retrieves information about the status, configuration, and other settings for all versions of a campaign.

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 identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    • CampaignId — (String)

      The unique identifier for the campaign.

    • PageSize — (String)

      The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

    • Token — (String)

      The NextToken string that specifies which page of results to return 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)

        Provides information about the configuration and other settings for all the campaigns that are associated with an application.

        • Itemrequired — (Array<map>)

          An array of responses, one for each campaign that's associated with the application.

          • AdditionalTreatments — (Array<map>)

            An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.

            • Idrequired — (String)

              The unique identifier for the treatment.

            • MessageConfiguration — (map)

              The message configuration settings for the treatment.

              • ADMMessage — (map)

                The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.

                • Action — (String)

                  The action to occur if a recipient taps the push notification. Valid values are:

                  • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

                  • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

                  • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

                  Possible values include:
                  • "OPEN_APP"
                  • "DEEP_LINK"
                  • "URL"
                • Body — (String)

                  The body of the notification message. The maximum number of characters is 200.

                • ImageIconUrl — (String)

                  The URL of the image to display as the push-notification icon, such as the icon for the app.

                • ImageSmallIconUrl — (String)

                  The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

                • ImageUrl — (String)

                  The URL of an image to display in the push notification.

                • JsonBody — (String)

                  The JSON payload to use for a silent push notification.

                • MediaUrl — (String)

                  The URL of the image or video to display in the push notification.

                • RawContent — (String)

                  The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

                • SilentPush — (Boolean)

                  Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

                • TimeToLive — (Integer)

                  The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

                  This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

                • Title — (String)

                  The title to display above the notification message on a recipient's device.

                • Url — (String)

                  The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

              • APNSMessage — (map)

                The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.

                • Action — (String)

                  The action to occur if a recipient taps the push notification. Valid values are:

                  • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

                  • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

                  • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

                  Possible values include:
                  • "OPEN_APP"
                  • "DEEP_LINK"
                  • "URL"
                • Body — (String)

                  The body of the notification message. The maximum number of characters is 200.

                • ImageIconUrl — (String)

                  The URL of the image to display as the push-notification icon, such as the icon for the app.

                • ImageSmallIconUrl — (String)

                  The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

                • ImageUrl — (String)

                  The URL of an image to display in the push notification.

                • JsonBody — (String)

                  The JSON payload to use for a silent push notification.

                • MediaUrl — (String)

                  The URL of the image or video to display in the push notification.

                • RawContent — (String)

                  The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

                • SilentPush — (Boolean)

                  Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

                • TimeToLive — (Integer)

                  The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

                  This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

                • Title — (String)

                  The title to display above the notification message on a recipient's device.

                • Url — (String)

                  The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

              • BaiduMessage — (map)

                The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.

                • Action — (String)

                  The action to occur if a recipient taps the push notification. Valid values are:

                  • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

                  • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

                  • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

                  Possible values include:
                  • "OPEN_APP"
                  • "DEEP_LINK"
                  • "URL"
                • Body — (String)

                  The body of the notification message. The maximum number of characters is 200.

                • ImageIconUrl — (String)

                  The URL of the image to display as the push-notification icon, such as the icon for the app.

                • ImageSmallIconUrl — (String)

                  The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

                • ImageUrl — (String)

                  The URL of an image to display in the push notification.

                • JsonBody — (String)

                  The JSON payload to use for a silent push notification.

                • MediaUrl — (String)

                  The URL of the image or video to display in the push notification.

                • RawContent — (String)

                  The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

                • SilentPush — (Boolean)

                  Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

                • TimeToLive — (Integer)

                  The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

                  This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

                • Title — (String)

                  The title to display above the notification message on a recipient's device.

                • Url — (String)

                  The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

              • DefaultMessage — (map)

                The default message that the campaign sends through all the channels that are configured for the campaign.

                • Action — (String)

                  The action to occur if a recipient taps the push notification. Valid values are:

                  • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

                  • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

                  • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

                  Possible values include:
                  • "OPEN_APP"
                  • "DEEP_LINK"
                  • "URL"
                • Body — (String)

                  The body of the notification message. The maximum number of characters is 200.

                • ImageIconUrl — (String)

                  The URL of the image to display as the push-notification icon, such as the icon for the app.

                • ImageSmallIconUrl — (String)

                  The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

                • ImageUrl — (String)

                  The URL of an image to display in the push notification.

                • JsonBody — (String)

                  The JSON payload to use for a silent push notification.

                • MediaUrl — (String)

                  The URL of the image or video to display in the push notification.

                • RawContent — (String)

                  The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

                • SilentPush — (Boolean)

                  Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

                • TimeToLive — (Integer)

                  The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

                  This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

                • Title — (String)

                  The title to display above the notification message on a recipient's device.

                • Url — (String)

                  The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

              • EmailMessage — (map)

                The message that the campaign sends through the email channel.

                • Body — (String)

                  The body of the email for recipients whose email clients don't render HTML content.

                • FromAddress — (String)

                  The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.

                • HtmlBody — (String)

                  The body of the email, in HTML format, for recipients whose email clients render HTML content.

                • Titlerequired — (String)

                  The subject line, or title, of the email.

              • GCMMessage — (map)

                The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default message.

                • Action — (String)

                  The action to occur if a recipient taps the push notification. Valid values are:

                  • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

                  • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

                  • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

                  Possible values include:
                  • "OPEN_APP"
                  • "DEEP_LINK"
                  • "URL"
                • Body — (String)

                  The body of the notification message. The maximum number of characters is 200.

                • ImageIconUrl — (String)

                  The URL of the image to display as the push-notification icon, such as the icon for the app.

                • ImageSmallIconUrl — (String)

                  The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

                • ImageUrl — (String)

                  The URL of an image to display in the push notification.

                • JsonBody — (String)

                  The JSON payload to use for a silent push notification.

                • MediaUrl — (String)

                  The URL of the image or video to display in the push notification.

                • RawContent — (String)

                  The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

                • SilentPush — (Boolean)

                  Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

                • TimeToLive — (Integer)

                  The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

                  This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

                • Title — (String)

                  The title to display above the notification message on a recipient's device.

                • Url — (String)

                  The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

              • SMSMessage — (map)

                The message that the campaign sends through the SMS channel.

                • Body — (String)

                  The body of the SMS message.

                • MessageType — (String)

                  The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.

                  Possible values include:
                  • "TRANSACTIONAL"
                  • "PROMOTIONAL"
                • SenderId — (String)

                  The sender ID to display on recipients' devices when they receive the SMS message.

            • Schedule — (map)

              The schedule settings for the treatment.

              • EndTime — (String)

                The scheduled time, in ISO 8601 format, when the campaign ended or will end.

              • EventFilter — (map)

                The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.

                • Dimensionsrequired — (map)

                  The dimension settings of the event filter for the campaign.

                  • Attributes — (map<map>)

                    One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.

                    • AttributeType — (String)

                      The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                      Possible values include:
                      • "INCLUSIVE"
                      • "EXCLUSIVE"
                    • Valuesrequired — (Array<String>)

                      The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

                  • EventType — (map)

                    The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard type of event that Amazon Pinpoint generates, such as _email.delivered, or a custom event that's specific to your application.

                    • DimensionType — (String)

                      The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                      Possible values include:
                      • "INCLUSIVE"
                      • "EXCLUSIVE"
                    • Valuesrequired — (Array<String>)

                      The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                  • Metrics — (map<map>)

                    One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.

                    • ComparisonOperatorrequired — (String)

                      The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.

                    • Valuerequired — (Float)

                      The value to compare.

                • FilterTyperequired — (String)

                  The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Events resource) occurs.

                  Possible values include:
                  • "SYSTEM"
                  • "ENDPOINT"
              • Frequency — (String)

                Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.

                Possible values include:
                • "ONCE"
                • "HOURLY"
                • "DAILY"
                • "WEEKLY"
                • "MONTHLY"
                • "EVENT"
              • IsLocalTime — (Boolean)

                Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.

              • QuietTime — (map)

                The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:

                • The EndpointDemographic.Timezone property of the endpoint is set to a valid value.

                • The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.

                • The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.

                If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.

                • End — (String)

                  The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

                • Start — (String)

                  The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

              • StartTimerequired — (String)

                The scheduled time, in ISO 8601 format, when the campaign began or will begin.

              • Timezone — (String)

                The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.

            • SizePercentrequired — (Integer)

              The allocated percentage of users (segment members) that the treatment is sent to.

            • State — (map)

              The current status of the treatment.

              • CampaignStatus — (String)

                The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED.

                Possible values include:
                • "SCHEDULED"
                • "EXECUTING"
                • "PENDING_NEXT_RUN"
                • "COMPLETED"
                • "PAUSED"
                • "DELETED"
            • TemplateConfiguration — (map)

              The message template to use for the treatment.

              • EmailTemplate — (map)

                The email template to use for the message.

                • Name — (String)

                  The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

              • PushTemplate — (map)

                The push notification template to use for the message.

                • Name — (String)

                  The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

              • SMSTemplate — (map)

                The SMS template to use for the message.

                • Name — (String)

                  The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

              • VoiceTemplate — (map)

                The voice template to use for the message.

                • Name — (String)

                  The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

            • TreatmentDescription — (String)

              The custom description of the treatment.

            • TreatmentName — (String)

              The custom name of the treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.

          • ApplicationIdrequired — (String)

            The unique identifier for the application that the campaign applies to.

          • Arnrequired — (String)

            The Amazon Resource Name (ARN) of the campaign.

          • CreationDaterequired — (String)

            The date, ISO 8601 format, when the campaign was created.

          • DefaultState — (map)

            The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment, to support A/B testing.

            • CampaignStatus — (String)

              The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED.

              Possible values include:
              • "SCHEDULED"
              • "EXECUTING"
              • "PENDING_NEXT_RUN"
              • "COMPLETED"
              • "PAUSED"
              • "DELETED"
          • Description — (String)

            The custom description of the campaign.

          • HoldoutPercent — (Integer)

            The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.

          • Hook — (map)

            The settings for the AWS Lambda function to use as a code hook for the campaign.

            • LambdaFunctionName — (String)

              The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to send messages for a campaign.

            • Mode — (String)

              Specifies which Lambda mode to use when invoking the AWS Lambda function.

              Possible values include:
              • "DELIVERY"
              • "FILTER"
            • WebUrl — (String)

              The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.

          • Idrequired — (String)

            The unique identifier for the campaign.

          • IsPaused — (Boolean)

            Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.

          • LastModifiedDaterequired — (String)

            The date, in ISO 8601 format, when the campaign was last modified.

          • Limits — (map)

            The messaging limits for the campaign.

            • Daily — (Integer)

              The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. The maximum value is 100.

            • MaximumDuration — (Integer)

              The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.

            • MessagesPerSecond — (Integer)

              The maximum number of messages that a campaign can send each second. The minimum value is 50. The maximum value is 20,000.

            • Total — (Integer)

              The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. The maximum value is 100.

          • MessageConfiguration — (map)

            The message configuration settings for the campaign.

            • ADMMessage — (map)

              The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.

              • Action — (String)

                The action to occur if a recipient taps the push notification. Valid values are:

                • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

                • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

                • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

                Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • Body — (String)

                The body of the notification message. The maximum number of characters is 200.

              • ImageIconUrl — (String)

                The URL of the image to display as the push-notification icon, such as the icon for the app.

              • ImageSmallIconUrl — (String)

                The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

              • ImageUrl — (String)

                The URL of an image to display in the push notification.

              • JsonBody — (String)

                The JSON payload to use for a silent push notification.

              • MediaUrl — (String)

                The URL of the image or video to display in the push notification.

              • RawContent — (String)

                The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

              • SilentPush — (Boolean)

                Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

              • TimeToLive — (Integer)

                The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

                This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

              • Title — (String)

                The title to display above the notification message on a recipient's device.

              • Url — (String)

                The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

            • APNSMessage — (map)

              The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.

              • Action — (String)

                The action to occur if a recipient taps the push notification. Valid values are:

                • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

                • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

                • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

                Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • Body — (String)

                The body of the notification message. The maximum number of characters is 200.

              • ImageIconUrl — (String)

                The URL of the image to display as the push-notification icon, such as the icon for the app.

              • ImageSmallIconUrl — (String)

                The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

              • ImageUrl — (String)

                The URL of an image to display in the push notification.

              • JsonBody — (String)

                The JSON payload to use for a silent push notification.

              • MediaUrl — (String)

                The URL of the image or video to display in the push notification.

              • RawContent — (String)

                The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

              • SilentPush — (Boolean)

                Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

              • TimeToLive — (Integer)

                The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

                This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

              • Title — (String)

                The title to display above the notification message on a recipient's device.

              • Url — (String)

                The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

            • BaiduMessage — (map)

              The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.

              • Action — (String)

                The action to occur if a recipient taps the push notification. Valid values are:

                • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

                • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

                • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

                Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • Body — (String)

                The body of the notification message. The maximum number of characters is 200.

              • ImageIconUrl — (String)

                The URL of the image to display as the push-notification icon, such as the icon for the app.

              • ImageSmallIconUrl — (String)

                The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

              • ImageUrl — (String)

                The URL of an image to display in the push notification.

              • JsonBody — (String)

                The JSON payload to use for a silent push notification.

              • MediaUrl — (String)

                The URL of the image or video to display in the push notification.

              • RawContent — (String)

                The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

              • SilentPush — (Boolean)

                Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

              • TimeToLive — (Integer)

                The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

                This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

              • Title — (String)

                The title to display above the notification message on a recipient's device.

              • Url — (String)

                The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

            • DefaultMessage — (map)

              The default message that the campaign sends through all the channels that are configured for the campaign.

              • Action — (String)

                The action to occur if a recipient taps the push notification. Valid values are:

                • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

                • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

                • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

                Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • Body — (String)

                The body of the notification message. The maximum number of characters is 200.

              • ImageIconUrl — (String)

                The URL of the image to display as the push-notification icon, such as the icon for the app.

              • ImageSmallIconUrl — (String)

                The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

              • ImageUrl — (String)

                The URL of an image to display in the push notification.

              • JsonBody — (String)

                The JSON payload to use for a silent push notification.

              • MediaUrl — (String)

                The URL of the image or video to display in the push notification.

              • RawContent — (String)

                The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

              • SilentPush — (Boolean)

                Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

              • TimeToLive — (Integer)

                The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

                This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

              • Title — (String)

                The title to display above the notification message on a recipient's device.

              • Url — (String)

                The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

            • EmailMessage — (map)

              The message that the campaign sends through the email channel.

              • Body — (String)

                The body of the email for recipients whose email clients don't render HTML content.

              • FromAddress — (String)

                The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.

              • HtmlBody — (String)

                The body of the email, in HTML format, for recipients whose email clients render HTML content.

              • Titlerequired — (String)

                The subject line, or title, of the email.

            • GCMMessage — (map)

              The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default message.

              • Action — (String)

                The action to occur if a recipient taps the push notification. Valid values are:

                • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

                • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

                • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

                Possible values include:
                • "OPEN_APP"
                • "DEEP_LINK"
                • "URL"
              • Body — (String)

                The body of the notification message. The maximum number of characters is 200.

              • ImageIconUrl — (String)

                The URL of the image to display as the push-notification icon, such as the icon for the app.

              • ImageSmallIconUrl — (String)

                The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

              • ImageUrl — (String)

                The URL of an image to display in the push notification.

              • JsonBody — (String)

                The JSON payload to use for a silent push notification.

              • MediaUrl — (String)

                The URL of the image or video to display in the push notification.

              • RawContent — (String)

                The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

              • SilentPush — (Boolean)

                Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

              • TimeToLive — (Integer)

                The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

                This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

              • Title — (String)

                The title to display above the notification message on a recipient's device.

              • Url — (String)

                The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

            • SMSMessage — (map)

              The message that the campaign sends through the SMS channel.

              • Body — (String)

                The body of the SMS message.

              • MessageType — (String)

                The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.

                Possible values include:
                • "TRANSACTIONAL"
                • "PROMOTIONAL"
              • SenderId — (String)

                The sender ID to display on recipients' devices when they receive the SMS message.

          • Name — (String)

            The name of the campaign.

          • Schedule — (map)

            The schedule settings for the campaign.

            • EndTime — (String)

              The scheduled time, in ISO 8601 format, when the campaign ended or will end.

            • EventFilter — (map)

              The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.

              • Dimensionsrequired — (map)

                The dimension settings of the event filter for the campaign.

                • Attributes — (map<map>)

                  One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.

                  • AttributeType — (String)

                    The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                    Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Valuesrequired — (Array<String>)

                    The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

                • EventType — (map)

                  The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard type of event that Amazon Pinpoint generates, such as _email.delivered, or a custom event that's specific to your application.

                  • DimensionType — (String)

                    The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

                    Possible values include:
                    • "INCLUSIVE"
                    • "EXCLUSIVE"
                  • Valuesrequired — (Array<String>)

                    The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

                • Metrics — (map<map>)

                  One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.

                  • ComparisonOperatorrequired — (String)

                    The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.

                  • Valuerequired — (Float)

                    The value to compare.

              • FilterTyperequired — (String)

                The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Events resource) occurs.

                Possible values include:
                • "SYSTEM"
                • "ENDPOINT"
            • Frequency — (String)

              Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.

              Possible values include:
              • "ONCE"
              • "HOURLY"
              • "DAILY"
              • "WEEKLY"
              • "MONTHLY"
              • "EVENT"
            • IsLocalTime — (Boolean)

              Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.

            • QuietTime — (map)

              The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:

              • The EndpointDemographic.Timezone property of the endpoint is set to a valid value.

              • The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.

              • The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.

              If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.

              • End — (String)

                The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

              • Start — (String)

                The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

            • StartTimerequired — (String)

              The scheduled time, in ISO 8601 format, when the campaign began or will begin.

            • Timezone — (String)

              The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.

          • SegmentIdrequired — (String)

            The unique identifier for the segment that's associated with the campaign.

          • SegmentVersionrequired — (Integer)

            The version number of the segment that's associated with the campaign.

          • State — (map)

            The current status of the campaign.

            • CampaignStatus — (String)

              The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED.

              Possible values include:
              • "SCHEDULED"
              • "EXECUTING"
              • "PENDING_NEXT_RUN"
              • "COMPLETED"
              • "PAUSED"
              • "DELETED"
          • tags — (map<String>)

            A string-t