Class: AWS.PinpointEmail

Inherits:
AWS.Service show all
Identifier:
pinpointemail
API Version:
2018-07-26
Defined in:
(unknown)

Overview

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

Service Description

This document contains reference information for the Amazon Pinpoint Email API, version 1.0. This document is best used in conjunction with the Amazon Pinpoint Developer Guide.

The Amazon Pinpoint Email API is available in several AWS Regions and it provides an endpoint for each of these Regions. For a list of all the Regions and endpoints where the API is currently available, see AWS Regions and Endpoints in the Amazon Web Services General Reference.

In each Region, AWS maintains multiple Availability Zones. These Availability Zones are physically isolated from each other, but are united by private, low-latency, high-throughput, and highly redundant network connections. These Availability Zones enable us to provide very high levels of availability and redundancy, while also minimizing latency. To learn more about the number of Availability Zones that are available in each Region, see AWS Global Infrastructure.

Sending a Request Using PinpointEmail

var pinpointemail = new AWS.PinpointEmail();
pinpointemail.getBlacklistReports(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 PinpointEmail object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var pinpointemail = new AWS.PinpointEmail({apiVersion: '2018-07-26'});

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

AWS.config.apiVersions = {
  pinpointemail: '2018-07-26',
  // other service API versions
};

var pinpointemail = new AWS.PinpointEmail();

Version:

  • 2018-07-26

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.PinpointEmail(options = {}) ⇒ Object

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

Examples:

Constructing a PinpointEmail object

var pinpointemail = new AWS.PinpointEmail({apiVersion: '2018-07-26'});

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.PinpointEmail.region for more information.

  • maxRetries (Integer)

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

  • maxRedirects (Integer)

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

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

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

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

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

  • convertResponseTypes (Boolean)

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

  • correctClockSkew (Boolean)

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

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

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

  • s3DisableBodySigning (Boolean)

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

  • retryDelayOptions (map)

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

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

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

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

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

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

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

  • logger (#write, #log)

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

  • systemClockOffset (Number)

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

  • signatureVersion (String)

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

  • signatureCache (Boolean)

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

  • dynamoDbCrc32 (Boolean)

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

  • useAccelerateEndpoint (Boolean)

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

  • clientSideMonitoring (Boolean)

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

  • endpointDiscoveryEnabled (Boolean)

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

  • endpointCacheSize (Number)

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

  • hostPrefixEnabled (Boolean)

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

Property Details

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

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

Create a configuration set. Configuration sets are groups of rules that you can apply to the emails you send using Amazon Pinpoint. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

Service Reference:

Examples:

Calling the createConfigurationSet operation

var params = {
  ConfigurationSetName: 'STRING_VALUE', /* required */
  DeliveryOptions: {
    SendingPoolName: 'STRING_VALUE',
    TlsPolicy: REQUIRE | OPTIONAL
  },
  ReputationOptions: {
    LastFreshStart: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    ReputationMetricsEnabled: true || false
  },
  SendingOptions: {
    SendingEnabled: true || false
  },
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  TrackingOptions: {
    CustomRedirectDomain: 'STRING_VALUE' /* required */
  }
};
pinpointemail.createConfigurationSet(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: {})
    • ConfigurationSetName — (String)

      The name of the configuration set.

    • TrackingOptions — (map)

      An object that defines the open and click tracking options for emails that you send using the configuration set.

      • CustomRedirectDomainrequired — (String)

        The domain that you want to use for tracking open and click events.

    • DeliveryOptions — (map)

      An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.

      • TlsPolicy — (String)

        Specifies whether Amazon Pinpoint should require that incoming email is delivered over a connection that’s encrypted by using Transport Layer Security (TLS). If this value is set to Require, Amazon Pinpoint will bounce email messages that cannot be delivered over TLS. The default value is Optional.

        Possible values include:
        • "REQUIRE"
        • "OPTIONAL"
      • SendingPoolName — (String)

        The name of the dedicated IP pool that you want to associate with the configuration set.

    • ReputationOptions — (map)

      An object that defines whether or not Amazon Pinpoint collects reputation metrics for the emails that you send that use the configuration set.

      • ReputationMetricsEnabled — (Boolean)

        If true, tracking of reputation metrics is enabled for the configuration set. If false, tracking of reputation metrics is disabled for the configuration set.

      • LastFreshStart — (Date)

        The date and time (in Unix time) when the reputation metrics were last given a fresh start. When your account is given a fresh start, your reputation metrics are calculated starting from the date of the fresh start.

    • SendingOptions — (map)

      An object that defines whether or not Amazon Pinpoint can send email that you send using the configuration set.

      • SendingEnabled — (Boolean)

        If true, email sending is enabled for the configuration set. If false, email sending is disabled for the configuration set.

    • Tags — (Array<map>)

      An array of objects that define the tags (keys and values) that you want to associate with the configuration set.

      • Keyrequired — (String)

        One part of a key-value pair that defines a tag. The maximum length of a tag key is 128 characters. The minimum length is 1 character.

      • Valuerequired — (String)

        The optional part of a key-value pair that defines a tag. The maximum length of a tag value is 256 characters. The minimum length is 0 characters. If you don’t want a resource to have a specific tag value, don’t specify a value for this parameter. Amazon Pinpoint will set the value to an empty string.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Create an event destination. In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.

A single configuration set can include more than one event destination.

Examples:

Calling the createConfigurationSetEventDestination operation

var params = {
  ConfigurationSetName: 'STRING_VALUE', /* required */
  EventDestination: { /* required */
    CloudWatchDestination: {
      DimensionConfigurations: [ /* required */
        {
          DefaultDimensionValue: 'STRING_VALUE', /* required */
          DimensionName: 'STRING_VALUE', /* required */
          DimensionValueSource: MESSAGE_TAG | EMAIL_HEADER | LINK_TAG /* required */
        },
        /* more items */
      ]
    },
    Enabled: true || false,
    KinesisFirehoseDestination: {
      DeliveryStreamArn: 'STRING_VALUE', /* required */
      IamRoleArn: 'STRING_VALUE' /* required */
    },
    MatchingEventTypes: [
      SEND | REJECT | BOUNCE | COMPLAINT | DELIVERY | OPEN | CLICK | RENDERING_FAILURE,
      /* more items */
    ],
    PinpointDestination: {
      ApplicationArn: 'STRING_VALUE'
    },
    SnsDestination: {
      TopicArn: 'STRING_VALUE' /* required */
    }
  },
  EventDestinationName: 'STRING_VALUE' /* required */
};
pinpointemail.createConfigurationSetEventDestination(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: {})
    • ConfigurationSetName — (String)

      The name of the configuration set that you want to add an event destination to.

    • EventDestinationName — (String)

      A name that identifies the event destination within the configuration set.

    • EventDestination — (map)

      An object that defines the event destination.

      • Enabled — (Boolean)

        If true, the event destination is enabled. When the event destination is enabled, the specified event types are sent to the destinations in this EventDestinationDefinition.

        If false, the event destination is disabled. When the event destination is disabled, events aren't sent to the specified destinations.

      • MatchingEventTypes — (Array<String>)

        An array that specifies which events Amazon Pinpoint should send to the destinations in this EventDestinationDefinition.

      • KinesisFirehoseDestination — (map)

        An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.

        • IamRoleArnrequired — (String)

          The Amazon Resource Name (ARN) of the IAM role that Amazon Pinpoint uses when sending email events to the Amazon Kinesis Data Firehose stream.

        • DeliveryStreamArnrequired — (String)

          The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose stream that Amazon Pinpoint sends email events to.

      • CloudWatchDestination — (map)

        An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics.

        • DimensionConfigurationsrequired — (Array<map>)

          An array of objects that define the dimensions to use when you send email events to Amazon CloudWatch.

          • DimensionNamerequired — (String)

            The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria:

            • It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

            • It can contain no more than 256 characters.

          • DimensionValueSourcerequired — (String)

            The location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon Pinpoint to use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail/SendRawEmail API, choose messageTag. If you want Amazon Pinpoint to use your own email headers, choose emailHeader. If you want Amazon Pinpoint to use link tags, choose linkTags.

            Possible values include:
            • "MESSAGE_TAG"
            • "EMAIL_HEADER"
            • "LINK_TAG"
          • DefaultDimensionValuerequired — (String)

            The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email. This value has to meet the following criteria:

            • It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

            • It can contain no more than 256 characters.

      • SnsDestination — (map)

        An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.

        • TopicArnrequired — (String)

          The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish email events to. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

      • PinpointDestination — (map)

        An object that defines a Amazon Pinpoint destination for email events. You can use Amazon Pinpoint events to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments for your campaigns.

        • ApplicationArn — (String)

          The Amazon Resource Name (ARN) of the Amazon Pinpoint project that you want to send email events to.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Create a new pool of dedicated IP addresses. A pool can include one or more dedicated IP addresses that are associated with your Amazon Pinpoint account. You can associate a pool with a configuration set. When you send an email that uses that configuration set, Amazon Pinpoint sends it using only the IP addresses in the associated pool.

Service Reference:

Examples:

Calling the createDedicatedIpPool operation

var params = {
  PoolName: 'STRING_VALUE', /* required */
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
pinpointemail.createDedicatedIpPool(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: {})
    • PoolName — (String)

      The name of the dedicated IP pool.

    • Tags — (Array<map>)

      An object that defines the tags (keys and values) that you want to associate with the pool.

      • Keyrequired — (String)

        One part of a key-value pair that defines a tag. The maximum length of a tag key is 128 characters. The minimum length is 1 character.

      • Valuerequired — (String)

        The optional part of a key-value pair that defines a tag. The maximum length of a tag value is 256 characters. The minimum length is 0 characters. If you don’t want a resource to have a specific tag value, don’t specify a value for this parameter. Amazon Pinpoint will set the value to an empty string.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Create a new predictive inbox placement test. Predictive inbox placement tests can help you predict how your messages will be handled by various email providers around the world. When you perform a predictive inbox placement test, you provide a sample message that contains the content that you plan to send to your customers. Amazon Pinpoint then sends that message to special email addresses spread across several major email providers. After about 24 hours, the test is complete, and you can use the GetDeliverabilityTestReport operation to view the results of the test.

Service Reference:

Examples:

Calling the createDeliverabilityTestReport operation

var params = {
  Content: { /* required */
    Raw: {
      Data: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */ /* required */
    },
    Simple: {
      Body: { /* required */
        Html: {
          Data: 'STRING_VALUE', /* required */
          Charset: 'STRING_VALUE'
        },
        Text: {
          Data: 'STRING_VALUE', /* required */
          Charset: 'STRING_VALUE'
        }
      },
      Subject: { /* required */
        Data: 'STRING_VALUE', /* required */
        Charset: 'STRING_VALUE'
      }
    }
  },
  FromEmailAddress: 'STRING_VALUE', /* required */
  ReportName: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
pinpointemail.createDeliverabilityTestReport(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: {})
    • ReportName — (String)

      A unique name that helps you to identify the predictive inbox placement test when you retrieve the results.

    • FromEmailAddress — (String)

      The email address that the predictive inbox placement test email was sent from.

    • Content — (map)

      The HTML body of the message that you sent when you performed the predictive inbox placement test.

      • Simple — (map)

        The simple email message. The message consists of a subject and a message body.

        • Subjectrequired — (map)

          The subject line of the email. The subject line can only contain 7-bit ASCII characters. However, you can specify non-ASCII characters in the subject line by using encoded-word syntax, as described in RFC 2047.

          • Datarequired — (String)

            The content of the message itself.

          • Charset — (String)

            The character set for the content. Because of the constraints of the SMTP protocol, Amazon Pinpoint uses 7-bit ASCII by default. If the text includes characters outside of the ASCII range, you have to specify a character set. For example, you could specify UTF-8, ISO-8859-1, or Shift_JIS.

        • Bodyrequired — (map)

          The body of the message. You can specify an HTML version of the message, a text-only version of the message, or both.

          • Text — (map)

            An object that represents the version of the message that is displayed in email clients that don't support HTML, or clients where the recipient has disabled HTML rendering.

            • Datarequired — (String)

              The content of the message itself.

            • Charset — (String)

              The character set for the content. Because of the constraints of the SMTP protocol, Amazon Pinpoint uses 7-bit ASCII by default. If the text includes characters outside of the ASCII range, you have to specify a character set. For example, you could specify UTF-8, ISO-8859-1, or Shift_JIS.

          • Html — (map)

            An object that represents the version of the message that is displayed in email clients that support HTML. HTML messages can include formatted text, hyperlinks, images, and more.

            • Datarequired — (String)

              The content of the message itself.

            • Charset — (String)

              The character set for the content. Because of the constraints of the SMTP protocol, Amazon Pinpoint uses 7-bit ASCII by default. If the text includes characters outside of the ASCII range, you have to specify a character set. For example, you could specify UTF-8, ISO-8859-1, or Shift_JIS.

      • Raw — (map)

        The raw email message. The message has to meet the following criteria:

        • The message has to contain a header and a body, separated by one blank line.

        • All of the required header fields must be present in the message.

        • Each part of a multipart MIME message must be formatted properly.

        • If you include attachments, they must be in a file format that Amazon Pinpoint supports.

        • The entire message must be Base64 encoded.

        • If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, you should encode that content to ensure that recipients' email clients render the message properly.

        • The length of any single line of text in the message can't exceed 1,000 characters. This restriction is defined in RFC 5321.

        • Datarequired — (Buffer, Typed Array, Blob, String)

          The raw email message. The message has to meet the following criteria:

          • The message has to contain a header and a body, separated by one blank line.

          • All of the required header fields must be present in the message.

          • Each part of a multipart MIME message must be formatted properly.

          • Attachments must be in a file format that Amazon Pinpoint supports.

          • The entire message must be Base64 encoded.

          • If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, you should encode that content to ensure that recipients' email clients render the message properly.

          • The length of any single line of text in the message can't exceed 1,000 characters. This restriction is defined in RFC 5321.

    • Tags — (Array<map>)

      An array of objects that define the tags (keys and values) that you want to associate with the predictive inbox placement test.

      • Keyrequired — (String)

        One part of a key-value pair that defines a tag. The maximum length of a tag key is 128 characters. The minimum length is 1 character.

      • Valuerequired — (String)

        The optional part of a key-value pair that defines a tag. The maximum length of a tag value is 256 characters. The minimum length is 0 characters. If you don’t want a resource to have a specific tag value, don’t specify a value for this parameter. Amazon Pinpoint will set the value to an empty string.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • ReportId — (String)

        A unique string that identifies the predictive inbox placement test.

      • DeliverabilityTestStatus — (String)

        The status of the predictive inbox placement test. If the status is IN_PROGRESS, then the predictive inbox placement test is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the test. If the status is COMPLETE, then the test is finished, and you can use the GetDeliverabilityTestReport to view the results of the test.

        Possible values include:
        • "IN_PROGRESS"
        • "COMPLETED"

Returns:

  • (AWS.Request)

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

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

Verifies an email identity for use with Amazon Pinpoint. In Amazon Pinpoint, an identity is an email address or domain that you use when you send email. Before you can use an identity to send email with Amazon Pinpoint, you first have to verify it. By verifying an address, you demonstrate that you're the owner of the address, and that you've given Amazon Pinpoint permission to send email from the address.

When you verify an email address, Amazon Pinpoint sends an email to the address. Your email address is verified as soon as you follow the link in the verification email.

When you verify a domain, this operation provides a set of DKIM tokens, which you can convert into CNAME tokens. You add these CNAME tokens to the DNS configuration for your domain. Your domain is verified when Amazon Pinpoint detects these records in the DNS configuration for your domain. It usually takes around 72 hours to complete the domain verification process.

Service Reference:

Examples:

Calling the createEmailIdentity operation

var params = {
  EmailIdentity: 'STRING_VALUE', /* required */
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
pinpointemail.createEmailIdentity(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: {})
    • EmailIdentity — (String)

      The email address or domain that you want to verify.

    • Tags — (Array<map>)

      An array of objects that define the tags (keys and values) that you want to associate with the email identity.

      • Keyrequired — (String)

        One part of a key-value pair that defines a tag. The maximum length of a tag key is 128 characters. The minimum length is 1 character.

      • Valuerequired — (String)

        The optional part of a key-value pair that defines a tag. The maximum length of a tag value is 256 characters. The minimum length is 0 characters. If you don’t want a resource to have a specific tag value, don’t specify a value for this parameter. Amazon Pinpoint will set the value to an empty string.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • IdentityType — (String)

        The email identity type.

        Possible values include:
        • "EMAIL_ADDRESS"
        • "DOMAIN"
        • "MANAGED_DOMAIN"
      • VerifiedForSendingStatus — (Boolean)

        Specifies whether or not the identity is verified. In Amazon Pinpoint, you can only send email from verified email addresses or domains. For more information about verifying identities, see the Amazon Pinpoint User Guide.

      • DkimAttributes — (map)

        An object that contains information about the DKIM attributes for the identity. This object includes the tokens that you use to create the CNAME records that are required to complete the DKIM verification process.

        • SigningEnabled — (Boolean)

          If the value is true, then the messages that Amazon Pinpoint sends from the identity are DKIM-signed. If the value is false, then the messages that Amazon Pinpoint sends from the identity aren't DKIM-signed.

        • Status — (String)

          Describes whether or not Amazon Pinpoint has successfully located the DKIM records in the DNS records for the domain. The status can be one of the following:

          • PENDING – Amazon Pinpoint hasn't yet located the DKIM records in the DNS configuration for the domain, but will continue to attempt to locate them.

          • SUCCESS – Amazon Pinpoint located the DKIM records in the DNS configuration for the domain and determined that they're correct. Amazon Pinpoint can now send DKIM-signed email from the identity.

          • FAILED – Amazon Pinpoint was unable to locate the DKIM records in the DNS settings for the domain, and won't continue to search for them.

          • TEMPORARY_FAILURE – A temporary issue occurred, which prevented Amazon Pinpoint from determining the DKIM status for the domain.

          • NOT_STARTED – Amazon Pinpoint hasn't yet started searching for the DKIM records in the DKIM records for the domain.

          Possible values include:
          • "PENDING"
          • "SUCCESS"
          • "FAILED"
          • "TEMPORARY_FAILURE"
          • "NOT_STARTED"
        • Tokens — (Array<String>)

          A set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain. When Amazon Pinpoint detects these records in the DNS configuration for your domain, the DKIM authentication process is complete. Amazon Pinpoint usually detects these records within about 72 hours of adding them to the DNS configuration for your domain.

Returns:

  • (AWS.Request)

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

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

Delete an existing configuration set.

In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

Service Reference:

Examples:

Calling the deleteConfigurationSet operation

var params = {
  ConfigurationSetName: 'STRING_VALUE' /* required */
};
pinpointemail.deleteConfigurationSet(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: {})
    • ConfigurationSetName — (String)

      The name of the configuration set that you want to delete.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Delete an event destination.

In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.

Examples:

Calling the deleteConfigurationSetEventDestination operation

var params = {
  ConfigurationSetName: 'STRING_VALUE', /* required */
  EventDestinationName: 'STRING_VALUE' /* required */
};
pinpointemail.deleteConfigurationSetEventDestination(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: {})
    • ConfigurationSetName — (String)

      The name of the configuration set that contains the event destination that you want to delete.

    • EventDestinationName — (String)

      The name of the event destination that you want to delete.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Delete a dedicated IP pool.

Service Reference:

Examples:

Calling the deleteDedicatedIpPool operation

var params = {
  PoolName: 'STRING_VALUE' /* required */
};
pinpointemail.deleteDedicatedIpPool(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: {})
    • PoolName — (String)

      The name of the dedicated IP pool that you want to delete.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Deletes an email identity that you previously verified for use with Amazon Pinpoint. An identity can be either an email address or a domain name.

Service Reference:

Examples:

Calling the deleteEmailIdentity operation

var params = {
  EmailIdentity: 'STRING_VALUE' /* required */
};
pinpointemail.deleteEmailIdentity(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: {})
    • EmailIdentity — (String)

      The identity (that is, the email address or domain) that you want to delete from your Amazon Pinpoint account.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Obtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current AWS Region.

Service Reference:

Examples:

Calling the getAccount operation

var params = {
};
pinpointemail.getAccount(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: {})

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:

      • SendQuota — (map)

        An object that contains information about the per-day and per-second sending limits for your Amazon Pinpoint account in the current AWS Region.

        • Max24HourSend — (Float)

          The maximum number of emails that you can send in the current AWS Region over a 24-hour period. This value is also called your sending quota.

        • MaxSendRate — (Float)

          The maximum number of emails that you can send per second in the current AWS Region. This value is also called your maximum sending rate or your maximum TPS (transactions per second) rate.

        • SentLast24Hours — (Float)

          The number of emails sent from your Amazon Pinpoint account in the current AWS Region over the past 24 hours.

      • SendingEnabled — (Boolean)

        Indicates whether or not email sending is enabled for your Amazon Pinpoint account in the current AWS Region.

      • DedicatedIpAutoWarmupEnabled — (Boolean)

        Indicates whether or not the automatic warm-up feature is enabled for dedicated IP addresses that are associated with your account.

      • EnforcementStatus — (String)

        The reputation status of your Amazon Pinpoint account. The status can be one of the following:

        • HEALTHY – There are no reputation-related issues that currently impact your account.

        • PROBATION – We've identified some issues with your Amazon Pinpoint account. We're placing your account under review while you work on correcting these issues.

        • SHUTDOWN – Your account's ability to send email is currently paused because of an issue with the email sent from your account. When you correct the issue, you can contact us and request that your account's ability to send email is resumed.

      • ProductionAccessEnabled — (Boolean)

        Indicates whether or not your account has production access in the current AWS Region.

        If the value is false, then your account is in the sandbox. When your account is in the sandbox, you can only send email to verified identities. Additionally, the maximum number of emails you can send in a 24-hour period (your sending quota) is 200, and the maximum number of emails you can send per second (your maximum sending rate) is 1.

        If the value is true, then your account has production access. When your account has production access, you can send email to any address. The sending quota and maximum sending rate for your account vary based on your specific use case.

Returns:

  • (AWS.Request)

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

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

Retrieve a list of the blacklists that your dedicated IP addresses appear on.

Service Reference:

Examples:

Calling the getBlacklistReports operation

var params = {
  BlacklistItemNames: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
pinpointemail.getBlacklistReports(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: {})
    • BlacklistItemNames — (Array<String>)

      A list of IP addresses that you want to retrieve blacklist information about. You can only specify the dedicated IP addresses that you use to send email using Amazon Pinpoint or Amazon SES.

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:

      • BlacklistReport — (map<Array<map>>)

        An object that contains information about a blacklist that one of your dedicated IP addresses appears on.

        • RblName — (String)

          The name of the blacklist that the IP address appears on.

        • ListingTime — (Date)

          The time when the blacklisting event occurred, shown in Unix time format.

        • Description — (String)

          Additional information about the blacklisting event, as provided by the blacklist maintainer.

Returns:

  • (AWS.Request)

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

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

Get information about an existing configuration set, including the dedicated IP pool that it's associated with, whether or not it's enabled for sending email, and more.

In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

Service Reference:

Examples:

Calling the getConfigurationSet operation

var params = {
  ConfigurationSetName: 'STRING_VALUE' /* required */
};
pinpointemail.getConfigurationSet(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: {})
    • ConfigurationSetName — (String)

      The name of the configuration set that you want to obtain more information about.

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:

      • ConfigurationSetName — (String)

        The name of the configuration set.

      • TrackingOptions — (map)

        An object that defines the open and click tracking options for emails that you send using the configuration set.

        • CustomRedirectDomainrequired — (String)

          The domain that you want to use for tracking open and click events.

      • DeliveryOptions — (map)

        An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.

        • TlsPolicy — (String)

          Specifies whether Amazon Pinpoint should require that incoming email is delivered over a connection that’s encrypted by using Transport Layer Security (TLS). If this value is set to Require, Amazon Pinpoint will bounce email messages that cannot be delivered over TLS. The default value is Optional.

          Possible values include:
          • "REQUIRE"
          • "OPTIONAL"
        • SendingPoolName — (String)

          The name of the dedicated IP pool that you want to associate with the configuration set.

      • ReputationOptions — (map)

        An object that defines whether or not Amazon Pinpoint collects reputation metrics for the emails that you send that use the configuration set.

        • ReputationMetricsEnabled — (Boolean)

          If true, tracking of reputation metrics is enabled for the configuration set. If false, tracking of reputation metrics is disabled for the configuration set.

        • LastFreshStart — (Date)

          The date and time (in Unix time) when the reputation metrics were last given a fresh start. When your account is given a fresh start, your reputation metrics are calculated starting from the date of the fresh start.

      • SendingOptions — (map)

        An object that defines whether or not Amazon Pinpoint can send email that you send using the configuration set.

        • SendingEnabled — (Boolean)

          If true, email sending is enabled for the configuration set. If false, email sending is disabled for the configuration set.

      • Tags — (Array<map>)

        An array of objects that define the tags (keys and values) that are associated with the configuration set.

        • Keyrequired — (String)

          One part of a key-value pair that defines a tag. The maximum length of a tag key is 128 characters. The minimum length is 1 character.

        • Valuerequired — (String)

          The optional part of a key-value pair that defines a tag. The maximum length of a tag value is 256 characters. The minimum length is 0 characters. If you don’t want a resource to have a specific tag value, don’t specify a value for this parameter. Amazon Pinpoint will set the value to an empty string.

Returns:

  • (AWS.Request)

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

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

Retrieve a list of event destinations that are associated with a configuration set.

In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.

Examples:

Calling the getConfigurationSetEventDestinations operation

var params = {
  ConfigurationSetName: 'STRING_VALUE' /* required */
};
pinpointemail.getConfigurationSetEventDestinations(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: {})
    • ConfigurationSetName — (String)

      The name of the configuration set that contains the event destination.

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:

      • EventDestinations — (Array<map>)

        An array that includes all of the events destinations that have been configured for the configuration set.

        • Namerequired — (String)

          A name that identifies the event destination.

        • Enabled — (Boolean)

          If true, the event destination is enabled. When the event destination is enabled, the specified event types are sent to the destinations in this EventDestinationDefinition.

          If false, the event destination is disabled. When the event destination is disabled, events aren't sent to the specified destinations.

        • MatchingEventTypesrequired — (Array<String>)

          The types of events that Amazon Pinpoint sends to the specified event destinations.

        • KinesisFirehoseDestination — (map)

          An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.

          • IamRoleArnrequired — (String)

            The Amazon Resource Name (ARN) of the IAM role that Amazon Pinpoint uses when sending email events to the Amazon Kinesis Data Firehose stream.

          • DeliveryStreamArnrequired — (String)

            The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose stream that Amazon Pinpoint sends email events to.

        • CloudWatchDestination — (map)

          An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics.

          • DimensionConfigurationsrequired — (Array<map>)

            An array of objects that define the dimensions to use when you send email events to Amazon CloudWatch.

            • DimensionNamerequired — (String)

              The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria:

              • It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

              • It can contain no more than 256 characters.

            • DimensionValueSourcerequired — (String)

              The location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon Pinpoint to use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail/SendRawEmail API, choose messageTag. If you want Amazon Pinpoint to use your own email headers, choose emailHeader. If you want Amazon Pinpoint to use link tags, choose linkTags.

              Possible values include:
              • "MESSAGE_TAG"
              • "EMAIL_HEADER"
              • "LINK_TAG"
            • DefaultDimensionValuerequired — (String)

              The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email. This value has to meet the following criteria:

              • It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

              • It can contain no more than 256 characters.

        • SnsDestination — (map)

          An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.

          • TopicArnrequired — (String)

            The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish email events to. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

        • PinpointDestination — (map)

          An object that defines a Amazon Pinpoint destination for email events. You can use Amazon Pinpoint events to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments for your campaigns.

          • ApplicationArn — (String)

            The Amazon Resource Name (ARN) of the Amazon Pinpoint project that you want to send email events to.

Returns:

  • (AWS.Request)

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

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

Get information about a dedicated IP address, including the name of the dedicated IP pool that it's associated with, as well information about the automatic warm-up process for the address.

Service Reference:

Examples:

Calling the getDedicatedIp operation

var params = {
  Ip: 'STRING_VALUE' /* required */
};
pinpointemail.getDedicatedIp(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: {})
    • Ip — (String)

      The IP address that you want to obtain more information about. The value you specify has to be a dedicated IP address that's assocaited with your Amazon Pinpoint account.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • DedicatedIp — (map)

        An object that contains information about a dedicated IP address.

        • Iprequired — (String)

          An IP address that is reserved for use by your Amazon Pinpoint account.

        • WarmupStatusrequired — (String)

          The warm-up status of a dedicated IP address. The status can have one of the following values:

          • IN_PROGRESS – The IP address isn't ready to use because the dedicated IP warm-up process is ongoing.

          • DONE – The dedicated IP warm-up process is complete, and the IP address is ready to use.

          Possible values include:
          • "IN_PROGRESS"
          • "DONE"
        • WarmupPercentagerequired — (Integer)

          Indicates how complete the dedicated IP warm-up process is. When this value equals 1, the address has completed the warm-up process and is ready for use.

        • PoolName — (String)

          The name of the dedicated IP pool that the IP address is associated with.

Returns:

  • (AWS.Request)

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

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

List the dedicated IP addresses that are associated with your Amazon Pinpoint account.

Service Reference:

Examples:

Calling the getDedicatedIps operation

var params = {
  NextToken: 'STRING_VALUE',
  PageSize: 'NUMBER_VALUE',
  PoolName: 'STRING_VALUE'
};
pinpointemail.getDedicatedIps(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: {})
    • PoolName — (String)

      The name of the IP pool that the dedicated IP address is associated with.

    • NextToken — (String)

      A token returned from a previous call to GetDedicatedIps to indicate the position of the dedicated IP pool in the list of IP pools.

    • PageSize — (Integer)

      The number of results to show in a single call to GetDedicatedIpsRequest. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

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:

      • DedicatedIps — (Array<map>)

        A list of dedicated IP addresses that are reserved for use by your Amazon Pinpoint account.

        • Iprequired — (String)

          An IP address that is reserved for use by your Amazon Pinpoint account.

        • WarmupStatusrequired — (String)

          The warm-up status of a dedicated IP address. The status can have one of the following values:

          • IN_PROGRESS – The IP address isn't ready to use because the dedicated IP warm-up process is ongoing.

          • DONE – The dedicated IP warm-up process is complete, and the IP address is ready to use.

          Possible values include:
          • "IN_PROGRESS"
          • "DONE"
        • WarmupPercentagerequired — (Integer)

          Indicates how complete the dedicated IP warm-up process is. When this value equals 1, the address has completed the warm-up process and is ready for use.

        • PoolName — (String)

          The name of the dedicated IP pool that the IP address is associated with.

      • NextToken — (String)

        A token that indicates that there are additional dedicated IP addresses to list. To view additional addresses, issue another request to GetDedicatedIps, passing this token in the NextToken parameter.

Returns:

  • (AWS.Request)

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

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

Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account. When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests.

When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.

Examples:

Calling the getDeliverabilityDashboardOptions operation

var params = {
};
pinpointemail.getDeliverabilityDashboardOptions(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: {})

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:

      • DashboardEnabled — (Boolean)

        Specifies whether the Deliverability dashboard is enabled for your Amazon Pinpoint account. If this value is true, the dashboard is enabled.

      • SubscriptionExpiryDate — (Date)

        The date, in Unix time format, when your current subscription to the Deliverability dashboard is scheduled to expire, if your subscription is scheduled to expire at the end of the current calendar month. This value is null if you have an active subscription that isn’t due to expire at the end of the month.

      • AccountStatus — (String)

        The current status of your Deliverability dashboard subscription. If this value is PENDING_EXPIRATION, your subscription is scheduled to expire at the end of the current calendar month.

        Possible values include:
        • "ACTIVE"
        • "PENDING_EXPIRATION"
        • "DISABLED"
      • ActiveSubscribedDomains — (Array<map>)

        An array of objects, one for each verified domain that you use to send email and currently has an active Deliverability dashboard subscription that isn’t scheduled to expire at the end of the current calendar month.

        • Domain — (String)

          A verified domain that’s associated with your AWS account and currently has an active Deliverability dashboard subscription.

        • SubscriptionStartDate — (Date)

          The date, in Unix time format, when you enabled the Deliverability dashboard for the domain.

        • InboxPlacementTrackingOption — (map)

          An object that contains information about the inbox placement data settings for the domain.

          • Global — (Boolean)

            Specifies whether inbox placement data is being tracked for the domain.

          • TrackedIsps — (Array<String>)

            An array of strings, one for each major email provider that the inbox placement data applies to.

      • PendingExpirationSubscribedDomains — (Array<map>)

        An array of objects, one for each verified domain that you use to send email and currently has an active Deliverability dashboard subscription that's scheduled to expire at the end of the current calendar month.

        • Domain — (String)

          A verified domain that’s associated with your AWS account and currently has an active Deliverability dashboard subscription.

        • SubscriptionStartDate — (Date)

          The date, in Unix time format, when you enabled the Deliverability dashboard for the domain.

        • InboxPlacementTrackingOption — (map)

          An object that contains information about the inbox placement data settings for the domain.

          • Global — (Boolean)

            Specifies whether inbox placement data is being tracked for the domain.

          • TrackedIsps — (Array<String>)

            An array of strings, one for each major email provider that the inbox placement data applies to.

Returns:

  • (AWS.Request)

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

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

Retrieve the results of a predictive inbox placement test.

Service Reference:

Examples:

Calling the getDeliverabilityTestReport operation

var params = {
  ReportId: 'STRING_VALUE' /* required */
};
pinpointemail.getDeliverabilityTestReport(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: {})
    • ReportId — (String)

      A unique string that identifies the predictive inbox placement test.

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:

      • DeliverabilityTestReport — (map)

        An object that contains the results of the predictive inbox placement test.

        • ReportId — (String)

          A unique string that identifies the predictive inbox placement test.

        • ReportName — (String)

          A name that helps you identify a predictive inbox placement test report.

        • Subject — (String)

          The subject line for an email that you submitted in a predictive inbox placement test.

        • FromEmailAddress — (String)

          The sender address that you specified for the predictive inbox placement test.

        • CreateDate — (Date)

          The date and time when the predictive inbox placement test was created, in Unix time format.

        • DeliverabilityTestStatus — (String)

          The status of the predictive inbox placement test. If the status is IN_PROGRESS, then the predictive inbox placement test is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the test. If the status is COMPLETE, then the test is finished, and you can use the GetDeliverabilityTestReport to view the results of the test.

          Possible values include:
          • "IN_PROGRESS"
          • "COMPLETED"
      • OverallPlacement — (map)

        An object that specifies how many test messages that were sent during the predictive inbox placement test were delivered to recipients' inboxes, how many were sent to recipients' spam folders, and how many weren't delivered.

        • InboxPercentage — (Float)

          The percentage of emails that arrived in recipients' inboxes during the predictive inbox placement test.

        • SpamPercentage — (Float)

          The percentage of emails that arrived in recipients' spam or junk mail folders during the predictive inbox placement test.

        • MissingPercentage — (Float)

          The percentage of emails that didn't arrive in recipients' inboxes at all during the predictive inbox placement test.

        • SpfPercentage — (Float)

          The percentage of emails that were authenticated by using Sender Policy Framework (SPF) during the predictive inbox placement test.

        • DkimPercentage — (Float)

          The percentage of emails that were authenticated by using DomainKeys Identified Mail (DKIM) during the predictive inbox placement test.

      • IspPlacements — (Array<map>)

        An object that describes how the test email was handled by several email providers, including Gmail, Hotmail, Yahoo, AOL, and others.

        • IspName — (String)

          The name of the email provider that the inbox placement data applies to.

        • PlacementStatistics — (map)

          An object that contains inbox placement metrics for a specific email provider.

          • InboxPercentage — (Float)

            The percentage of emails that arrived in recipients' inboxes during the predictive inbox placement test.

          • SpamPercentage — (Float)

            The percentage of emails that arrived in recipients' spam or junk mail folders during the predictive inbox placement test.

          • MissingPercentage — (Float)

            The percentage of emails that didn't arrive in recipients' inboxes at all during the predictive inbox placement test.

          • SpfPercentage — (Float)

            The percentage of emails that were authenticated by using Sender Policy Framework (SPF) during the predictive inbox placement test.

          • DkimPercentage — (Float)

            The percentage of emails that were authenticated by using DomainKeys Identified Mail (DKIM) during the predictive inbox placement test.

      • Message — (String)

        An object that contains the message that you sent when you performed this predictive inbox placement test.

      • Tags — (Array<map>)

        An array of objects that define the tags (keys and values) that are associated with the predictive inbox placement test.

        • Keyrequired — (String)

          One part of a key-value pair that defines a tag. The maximum length of a tag key is 128 characters. The minimum length is 1 character.

        • Valuerequired — (String)

          The optional part of a key-value pair that defines a tag. The maximum length of a tag value is 256 characters. The minimum length is 0 characters. If you don’t want a resource to have a specific tag value, don’t specify a value for this parameter. Amazon Pinpoint will set the value to an empty string.

Returns:

  • (AWS.Request)

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

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

Retrieve all the deliverability data for a specific campaign. This data is available for a campaign only if the campaign sent email by using a domain that the Deliverability dashboard is enabled for (PutDeliverabilityDashboardOption operation).

Service Reference:

Examples:

Calling the getDomainDeliverabilityCampaign operation

var params = {
  CampaignId: 'STRING_VALUE' /* required */
};
pinpointemail.getDomainDeliverabilityCampaign(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: {})
    • CampaignId — (String)

      The unique identifier for the campaign. Amazon Pinpoint automatically generates and assigns this identifier to a campaign. This value is not the same as the campaign identifier that Amazon Pinpoint assigns to campaigns that you create and manage by using the Amazon Pinpoint API or 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:

      • DomainDeliverabilityCampaign — (map)

        An object that contains the deliverability data for the campaign.

        • CampaignId — (String)

          The unique identifier for the campaign. Amazon Pinpoint automatically generates and assigns this identifier to a campaign. This value is not the same as the campaign identifier that Amazon Pinpoint assigns to campaigns that you create and manage by using the Amazon Pinpoint API or the Amazon Pinpoint console.

        • ImageUrl — (String)

          The URL of an image that contains a snapshot of the email message that was sent.

        • Subject — (String)

          The subject line, or title, of the email message.

        • FromAddress — (String)

          The verified email address that the email message was sent from.

        • SendingIps — (Array<String>)

          The IP addresses that were used to send the email message.

        • FirstSeenDateTime — (Date)

          The first time, in Unix time format, when the email message was delivered to any recipient's inbox. This value can help you determine how long it took for a campaign to deliver an email message.

        • LastSeenDateTime — (Date)

          The last time, in Unix time format, when the email message was delivered to any recipient's inbox. This value can help you determine how long it took for a campaign to deliver an email message.

        • InboxCount — (Integer)

          The number of email messages that were delivered to recipients’ inboxes.

        • SpamCount — (Integer)

          The number of email messages that were delivered to recipients' spam or junk mail folders.

        • ReadRate — (Float)

          The percentage of email messages that were opened by recipients. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.

        • DeleteRate — (Float)

          The percentage of email messages that were deleted by recipients, without being opened first. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.

        • ReadDeleteRate — (Float)

          The percentage of email messages that were opened and then deleted by recipients. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.

        • ProjectedVolume — (Integer)

          The projected number of recipients that the email message was sent to.

        • Esps — (Array<String>)

          The major email providers who handled the email message.

Returns:

  • (AWS.Request)

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

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

Retrieve inbox placement and engagement rates for the domains that you use to send email.

Service Reference:

Examples:

Calling the getDomainStatisticsReport operation

var params = {
  Domain: 'STRING_VALUE', /* required */
  EndDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  StartDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789 /* required */
};
pinpointemail.getDomainStatisticsReport(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: {})
    • Domain — (String)

      The domain that you want to obtain deliverability metrics for.

    • StartDate — (Date)

      The first day (in Unix time) that you want to obtain domain deliverability metrics for.

    • EndDate — (Date)

      The last day (in Unix time) that you want to obtain domain deliverability metrics for. The EndDate that you specify has to be less than or equal to 30 days after the StartDate.

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:

      • OverallVolume — (map)

        An object that contains deliverability metrics for the domain that you specified. The data in this object is a summary of all of the data that was collected from the StartDate to the EndDate.

        • VolumeStatistics — (map)

          An object that contains information about the numbers of messages that arrived in recipients' inboxes and junk mail folders.

          • InboxRawCount — (Integer)

            The total number of emails that arrived in recipients' inboxes.

          • SpamRawCount — (Integer)

            The total number of emails that arrived in recipients' spam or junk mail folders.

          • ProjectedInbox — (Integer)

            An estimate of the percentage of emails sent from the current domain that will arrive in recipients' inboxes.

          • ProjectedSpam — (Integer)

            An estimate of the percentage of emails sent from the current domain that will arrive in recipients' spam or junk mail folders.

        • ReadRatePercent — (Float)

          The percentage of emails that were sent from the domain that were read by their recipients.

        • DomainIspPlacements — (Array<map>)

          An object that contains inbox and junk mail placement metrics for individual email providers.

          • IspName — (String)

            The name of the email provider that the inbox placement data applies to.

          • InboxRawCount — (Integer)

            The total number of messages that were sent from the selected domain to the specified email provider that arrived in recipients' inboxes.

          • SpamRawCount — (Integer)

            The total number of messages that were sent from the selected domain to the specified email provider that arrived in recipients' spam or junk mail folders.

          • InboxPercentage — (Float)

            The percentage of messages that were sent from the selected domain to the specified email provider that arrived in recipients' inboxes.

          • SpamPercentage — (Float)

            The percentage of messages that were sent from the selected domain to the specified email provider that arrived in recipients' spam or junk mail folders.

      • DailyVolumes — (Array<map>)

        An object that contains deliverability metrics for the domain that you specified. This object contains data for each day, starting on the StartDate and ending on the EndDate.

        • StartDate — (Date)

          The date that the DailyVolume metrics apply to, in Unix time.

        • VolumeStatistics — (map)

          An object that contains inbox placement metrics for a specific day in the analysis period.

          • InboxRawCount — (Integer)

            The total number of emails that arrived in recipients' inboxes.

          • SpamRawCount — (Integer)

            The total number of emails that arrived in recipients' spam or junk mail folders.

          • ProjectedInbox — (Integer)

            An estimate of the percentage of emails sent from the current domain that will arrive in recipients' inboxes.

          • ProjectedSpam — (Integer)

            An estimate of the percentage of emails sent from the current domain that will arrive in recipients' spam or junk mail folders.

        • DomainIspPlacements — (Array<map>)

          An object that contains inbox placement metrics for a specified day in the analysis period, broken out by the recipient's email provider.

          • IspName — (String)

            The name of the email provider that the inbox placement data applies to.

          • InboxRawCount — (Integer)

            The total number of messages that were sent from the selected domain to the specified email provider that arrived in recipients' inboxes.

          • SpamRawCount — (Integer)

            The total number of messages that were sent from the selected domain to the specified email provider that arrived in recipients' spam or junk mail folders.

          • InboxPercentage — (Float)

            The percentage of messages that were sent from the selected domain to the specified email provider that arrived in recipients' inboxes.

          • SpamPercentage — (Float)

            The percentage of messages that were sent from the selected domain to the specified email provider that arrived in recipients' spam or junk mail folders.

Returns:

  • (AWS.Request)

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

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

Provides information about a specific identity associated with your Amazon Pinpoint account, including the identity's verification status, its DKIM authentication status, and its custom Mail-From settings.

Service Reference:

Examples:

Calling the getEmailIdentity operation

var params = {
  EmailIdentity: 'STRING_VALUE' /* required */
};
pinpointemail.getEmailIdentity(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: {})
    • EmailIdentity — (String)

      The email identity that you want to retrieve details for.

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:

      • IdentityType — (String)

        The email identity type.

        Possible values include:
        • "EMAIL_ADDRESS"
        • "DOMAIN"
        • "MANAGED_DOMAIN"
      • FeedbackForwardingStatus — (Boolean)

        The feedback forwarding configuration for the identity.

        If the value is true, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email.

        When you set this value to false, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic or another event destination. You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).

      • VerifiedForSendingStatus — (Boolean)

        Specifies whether or not the identity is verified. In Amazon Pinpoint, you can only send email from verified email addresses or domains. For more information about verifying identities, see the Amazon Pinpoint User Guide.

      • DkimAttributes — (map)

        An object that contains information about the DKIM attributes for the identity. This object includes the tokens that you use to create the CNAME records that are required to complete the DKIM verification process.

        • SigningEnabled — (Boolean)

          If the value is true, then the messages that Amazon Pinpoint sends from the identity are DKIM-signed. If the value is false, then the messages that Amazon Pinpoint sends from the identity aren't DKIM-signed.

        • Status — (String)

          Describes whether or not Amazon Pinpoint has successfully located the DKIM records in the DNS records for the domain. The status can be one of the following:

          • PENDING – Amazon Pinpoint hasn't yet located the DKIM records in the DNS configuration for the domain, but will continue to attempt to locate them.

          • SUCCESS – Amazon Pinpoint located the DKIM records in the DNS configuration for the domain and determined that they're correct. Amazon Pinpoint can now send DKIM-signed email from the identity.

          • FAILED – Amazon Pinpoint was unable to locate the DKIM records in the DNS settings for the domain, and won't continue to search for them.

          • TEMPORARY_FAILURE – A temporary issue occurred, which prevented Amazon Pinpoint from determining the DKIM status for the domain.

          • NOT_STARTED – Amazon Pinpoint hasn't yet started searching for the DKIM records in the DKIM records for the domain.

          Possible values include:
          • "PENDING"
          • "SUCCESS"
          • "FAILED"
          • "TEMPORARY_FAILURE"
          • "NOT_STARTED"
        • Tokens — (Array<String>)

          A set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain. When Amazon Pinpoint detects these records in the DNS configuration for your domain, the DKIM authentication process is complete. Amazon Pinpoint usually detects these records within about 72 hours of adding them to the DNS configuration for your domain.

      • MailFromAttributes — (map)

        An object that contains information about the Mail-From attributes for the email identity.

        • MailFromDomainrequired — (String)

          The name of a domain that an email identity uses as a custom MAIL FROM domain.

        • MailFromDomainStatusrequired — (String)

          The status of the MAIL FROM domain. This status can have the following values:

          • PENDING – Amazon Pinpoint hasn't started searching for the MX record yet.

          • SUCCESS – Amazon Pinpoint detected the required MX record for the MAIL FROM domain.

          • FAILED – Amazon Pinpoint can't find the required MX record, or the record no longer exists.

          • TEMPORARY_FAILURE – A temporary issue occurred, which prevented Amazon Pinpoint from determining the status of the MAIL FROM domain.

          Possible values include:
          • "PENDING"
          • "SUCCESS"
          • "FAILED"
          • "TEMPORARY_FAILURE"
        • BehaviorOnMxFailurerequired — (String)

          The action that Amazon Pinpoint to takes if it can't read the required MX record for a custom MAIL FROM domain. When you set this value to UseDefaultValue, Amazon Pinpoint uses amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage, Amazon Pinpoint returns a MailFromDomainNotVerified error, and doesn't attempt to deliver the email.

          These behaviors are taken when the custom MAIL FROM domain configuration is in the Pending, Failed, and TemporaryFailure states.

          Possible values include:
          • "USE_DEFAULT_VALUE"
          • "REJECT_MESSAGE"
      • Tags — (Array<map>)

        An array of objects that define the tags (keys and values) that are associated with the email identity.

        • Keyrequired — (String)

          One part of a key-value pair that defines a tag. The maximum length of a tag key is 128 characters. The minimum length is 1 character.

        • Valuerequired — (String)

          The optional part of a key-value pair that defines a tag. The maximum length of a tag value is 256 characters. The minimum length is 0 characters. If you don’t want a resource to have a specific tag value, don’t specify a value for this parameter. Amazon Pinpoint will set the value to an empty string.

Returns:

  • (AWS.Request)

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

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

List all of the configuration sets associated with your Amazon Pinpoint account in the current region.

In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

Service Reference:

Examples:

Calling the listConfigurationSets operation

var params = {
  NextToken: 'STRING_VALUE',
  PageSize: 'NUMBER_VALUE'
};
pinpointemail.listConfigurationSets(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: {})
    • NextToken — (String)

      A token returned from a previous call to ListConfigurationSets to indicate the position in the list of configuration sets.

    • PageSize — (Integer)

      The number of results to show in a single call to ListConfigurationSets. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

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:

      • ConfigurationSets — (Array<String>)

        An array that contains all of the configuration sets in your Amazon Pinpoint account in the current AWS Region.

      • NextToken — (String)

        A token that indicates that there are additional configuration sets to list. To view additional configuration sets, issue another request to ListConfigurationSets, and pass this token in the NextToken parameter.

Returns:

  • (AWS.Request)

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

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

List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS Region.

Service Reference:

Examples:

Calling the listDedicatedIpPools operation

var params = {
  NextToken: 'STRING_VALUE',
  PageSize: 'NUMBER_VALUE'
};
pinpointemail.listDedicatedIpPools(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: {})
    • NextToken — (String)

      A token returned from a previous call to ListDedicatedIpPools to indicate the position in the list of dedicated IP pools.

    • PageSize — (Integer)

      The number of results to show in a single call to ListDedicatedIpPools. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

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:

      • DedicatedIpPools — (Array<String>)

        A list of all of the dedicated IP pools that are associated with your Amazon Pinpoint account.

      • NextToken — (String)

        A token that indicates that there are additional IP pools to list. To view additional IP pools, issue another request to ListDedicatedIpPools, passing this token in the NextToken parameter.

Returns:

  • (AWS.Request)

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

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

Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses. For predictive inbox placement tests that are complete, you can use the GetDeliverabilityTestReport operation to view the results.

Service Reference:

Examples:

Calling the listDeliverabilityTestReports operation

var params = {
  NextToken: 'STRING_VALUE',
  PageSize: 'NUMBER_VALUE'
};
pinpointemail.listDeliverabilityTestReports(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: {})
    • NextToken — (String)

      A token returned from a previous call to ListDeliverabilityTestReports to indicate the position in the list of predictive inbox placement tests.

    • PageSize — (Integer)

      The number of results to show in a single call to ListDeliverabilityTestReports. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

      The value you specify has to be at least 0, and can be no more than 1000.

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:

      • DeliverabilityTestReports — (Array<map>)

        An object that contains a lists of predictive inbox placement tests that you've performed.

        • ReportId — (String)

          A unique string that identifies the predictive inbox placement test.

        • ReportName — (String)

          A name that helps you identify a predictive inbox placement test report.

        • Subject — (String)

          The subject line for an email that you submitted in a predictive inbox placement test.

        • FromEmailAddress — (String)

          The sender address that you specified for the predictive inbox placement test.

        • CreateDate — (Date)

          The date and time when the predictive inbox placement test was created, in Unix time format.

        • DeliverabilityTestStatus — (String)

          The status of the predictive inbox placement test. If the status is IN_PROGRESS, then the predictive inbox placement test is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the test. If the status is COMPLETE, then the test is finished, and you can use the GetDeliverabilityTestReport to view the results of the test.

          Possible values include:
          • "IN_PROGRESS"
          • "COMPLETED"
      • NextToken — (String)

        A token that indicates that there are additional predictive inbox placement tests to list. To view additional predictive inbox placement tests, issue another request to ListDeliverabilityTestReports, and pass this token in the NextToken parameter.

Returns:

  • (AWS.Request)

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

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

Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range. This data is available for a domain only if you enabled the Deliverability dashboard (PutDeliverabilityDashboardOption operation) for the domain.

Examples:

Calling the listDomainDeliverabilityCampaigns operation

var params = {
  EndDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  StartDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  SubscribedDomain: 'STRING_VALUE', /* required */
  NextToken: 'STRING_VALUE',
  PageSize: 'NUMBER_VALUE'
};
pinpointemail.listDomainDeliverabilityCampaigns(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: {})
    • StartDate — (Date)

      The first day, in Unix time format, that you want to obtain deliverability data for.

    • EndDate — (Date)

      The last day, in Unix time format, that you want to obtain deliverability data for. This value has to be less than or equal to 30 days after the value of the StartDate parameter.

    • SubscribedDomain — (String)

      The domain to obtain deliverability data for.

    • NextToken — (String)

      A token that’s returned from a previous call to the ListDomainDeliverabilityCampaigns operation. This token indicates the position of a campaign in the list of campaigns.

    • PageSize — (Integer)

      The maximum number of results to include in response to a single call to the ListDomainDeliverabilityCampaigns operation. If the number of results is larger than the number that you specify in this parameter, the response includes a NextToken element, which you can use to obtain additional results.

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:

      • DomainDeliverabilityCampaigns — (Array<map>)

        An array of responses, one for each campaign that used the domain to send email during the specified time range.

        • CampaignId — (String)

          The unique identifier for the campaign. Amazon Pinpoint automatically generates and assigns this identifier to a campaign. This value is not the same as the campaign identifier that Amazon Pinpoint assigns to campaigns that you create and manage by using the Amazon Pinpoint API or the Amazon Pinpoint console.

        • ImageUrl — (String)

          The URL of an image that contains a snapshot of the email message that was sent.

        • Subject — (String)

          The subject line, or title, of the email message.

        • FromAddress — (String)

          The verified email address that the email message was sent from.

        • SendingIps — (Array<String>)

          The IP addresses that were used to send the email message.

        • FirstSeenDateTime — (Date)

          The first time, in Unix time format, when the email message was delivered to any recipient's inbox. This value can help you determine how long it took for a campaign to deliver an email message.

        • LastSeenDateTime — (Date)

          The last time, in Unix time format, when the email message was delivered to any recipient's inbox. This value can help you determine how long it took for a campaign to deliver an email message.

        • InboxCount — (Integer)

          The number of email messages that were delivered to recipients’ inboxes.

        • SpamCount — (Integer)

          The number of email messages that were delivered to recipients' spam or junk mail folders.

        • ReadRate — (Float)

          The percentage of email messages that were opened by recipients. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.

        • DeleteRate — (Float)

          The percentage of email messages that were deleted by recipients, without being opened first. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.

        • ReadDeleteRate — (Float)

          The percentage of email messages that were opened and then deleted by recipients. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.

        • ProjectedVolume — (Integer)

          The projected number of recipients that the email message was sent to.

        • Esps — (Array<String>)

          The major email providers who handled the email message.

      • NextToken — (String)

        A token that’s returned from a previous call to the ListDomainDeliverabilityCampaigns operation. This token indicates the position of the campaign in the list of campaigns.

Returns:

  • (AWS.Request)

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

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

Returns a list of all of the email identities that are associated with your Amazon Pinpoint account. An identity can be either an email address or a domain. This operation returns identities that are verified as well as those that aren't.

Service Reference:

Examples:

Calling the listEmailIdentities operation

var params = {
  NextToken: 'STRING_VALUE',
  PageSize: 'NUMBER_VALUE'
};
pinpointemail.listEmailIdentities(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: {})
    • NextToken — (String)

      A token returned from a previous call to ListEmailIdentities to indicate the position in the list of identities.

    • PageSize — (Integer)

      The number of results to show in a single call to ListEmailIdentities. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

      The value you specify has to be at least 0, and can be no more than 1000.

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:

      • EmailIdentities — (Array<map>)

        An array that includes all of the identities associated with your Amazon Pinpoint account.

        • IdentityType — (String)

          The email identity type. The identity type can be one of the following:

          • EMAIL_ADDRESS – The identity is an email address.

          • DOMAIN – The identity is a domain.

          • MANAGED_DOMAIN – The identity is a domain that is managed by AWS.

          Possible values include:
          • "EMAIL_ADDRESS"
          • "DOMAIN"
          • "MANAGED_DOMAIN"
        • IdentityName — (String)

          The address or domain of the identity.

        • SendingEnabled — (Boolean)

          Indicates whether or not you can send email from the identity.

          In Amazon Pinpoint, an identity is an email address or domain that you send email from. Before you can send email from an identity, you have to demostrate that you own the identity, and that you authorize Amazon Pinpoint to send email from that identity.

      • NextToken — (String)

        A token that indicates that there are additional configuration sets to list. To view additional configuration sets, issue another request to ListEmailIdentities, and pass this token in the NextToken parameter.

Returns:

  • (AWS.Request)

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

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

Retrieve a list of the tags (keys and values) that are associated with a specified resource. A tag is a label that you optionally define and associate with a resource in Amazon Pinpoint. Each tag consists of a required tag key and an optional associated tag value. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key.

Service Reference:

Examples:

Calling the listTagsForResource operation

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

Parameters:

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

      The Amazon Resource Name (ARN) of the resource that you want to retrieve tag information for.

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:

      • Tags — (Array<map>)

        An array that lists all the tags that are associated with the resource. Each tag consists of a required tag key (Key) and an associated tag value (Value)

        • Keyrequired — (String)

          One part of a key-value pair that defines a tag. The maximum length of a tag key is 128 characters. The minimum length is 1 character.

        • Valuerequired — (String)

          The optional part of a key-value pair that defines a tag. The maximum length of a tag value is 256 characters. The minimum length is 0 characters. If you don’t want a resource to have a specific tag value, don’t specify a value for this parameter. Amazon Pinpoint will set the value to an empty string.

Returns:

  • (AWS.Request)

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

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

Enable or disable the automatic warm-up feature for dedicated IP addresses.

Examples:

Calling the putAccountDedicatedIpWarmupAttributes operation

var params = {
  AutoWarmupEnabled: true || false
};
pinpointemail.putAccountDedicatedIpWarmupAttributes(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: {})
    • AutoWarmupEnabled — (Boolean)

      Enables or disables the automatic warm-up feature for dedicated IP addresses that are associated with your Amazon Pinpoint account in the current AWS Region. Set to true to enable the automatic warm-up feature, or set to false to disable it.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Enable or disable the ability of your account to send email.

Service Reference:

Examples:

Calling the putAccountSendingAttributes operation

var params = {
  SendingEnabled: true || false
};
pinpointemail.putAccountSendingAttributes(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: {})
    • SendingEnabled — (Boolean)

      Enables or disables your account's ability to send email. Set to true to enable email sending, or set to false to disable email sending.

      Note: If AWS paused your account's ability to send email, you can't use this operation to resume your account's ability to send email.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Associate a configuration set with a dedicated IP pool. You can use dedicated IP pools to create groups of dedicated IP addresses for sending specific types of email.

Examples:

Calling the putConfigurationSetDeliveryOptions operation

var params = {
  ConfigurationSetName: 'STRING_VALUE', /* required */
  SendingPoolName: 'STRING_VALUE',
  TlsPolicy: REQUIRE | OPTIONAL
};
pinpointemail.putConfigurationSetDeliveryOptions(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: {})
    • ConfigurationSetName — (String)

      The name of the configuration set that you want to associate with a dedicated IP pool.

    • TlsPolicy — (String)

      Whether Amazon Pinpoint should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS).

      Possible values include:
      • "REQUIRE"
      • "OPTIONAL"
    • SendingPoolName — (String)

      The name of the dedicated IP pool that you want to associate with the configuration set.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific AWS Region.

Examples:

Calling the putConfigurationSetReputationOptions operation

var params = {
  ConfigurationSetName: 'STRING_VALUE', /* required */
  ReputationMetricsEnabled: true || false
};
pinpointemail.putConfigurationSetReputationOptions(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: {})
    • ConfigurationSetName — (String)

      The name of the configuration set that you want to enable or disable reputation metric tracking for.

    • ReputationMetricsEnabled — (Boolean)

      If true, tracking of reputation metrics is enabled for the configuration set. If false, tracking of reputation metrics is disabled for the configuration set.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Enable or disable email sending for messages that use a particular configuration set in a specific AWS Region.

Examples:

Calling the putConfigurationSetSendingOptions operation

var params = {
  ConfigurationSetName: 'STRING_VALUE', /* required */
  SendingEnabled: true || false
};
pinpointemail.putConfigurationSetSendingOptions(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: {})
    • ConfigurationSetName — (String)

      The name of the configuration set that you want to enable or disable email sending for.

    • SendingEnabled — (Boolean)

      If true, email sending is enabled for the configuration set. If false, email sending is disabled for the configuration set.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Specify a custom domain to use for open and click tracking elements in email that you send using Amazon Pinpoint.

Examples:

Calling the putConfigurationSetTrackingOptions operation

var params = {
  ConfigurationSetName: 'STRING_VALUE', /* required */
  CustomRedirectDomain: 'STRING_VALUE'
};
pinpointemail.putConfigurationSetTrackingOptions(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: {})
    • ConfigurationSetName — (String)

      The name of the configuration set that you want to add a custom tracking domain to.

    • CustomRedirectDomain — (String)

      The domain that you want to use to track open and click events.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Move a dedicated IP address to an existing dedicated IP pool.

Note: The dedicated IP address that you specify must already exist, and must be associated with your Amazon Pinpoint account. The dedicated IP pool you specify must already exist. You can create a new pool by using the CreateDedicatedIpPool operation.

Service Reference:

Examples:

Calling the putDedicatedIpInPool operation

var params = {
  DestinationPoolName: 'STRING_VALUE', /* required */
  Ip: 'STRING_VALUE' /* required */
};
pinpointemail.putDedicatedIpInPool(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: {})
    • Ip — (String)

      The IP address that you want to move to the dedicated IP pool. The value you specify has to be a dedicated IP address that's associated with your Amazon Pinpoint account.

    • DestinationPoolName — (String)

      The name of the IP pool that you want to add the dedicated IP address to. You have to specify an IP pool that already exists.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Service Reference:

Examples:

Calling the putDedicatedIpWarmupAttributes operation

var params = {
  Ip: 'STRING_VALUE', /* required */
  WarmupPercentage: 'NUMBER_VALUE' /* required */
};
pinpointemail.putDedicatedIpWarmupAttributes(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: {})
    • Ip — (String)

      The dedicated IP address that you want to update the warm-up attributes for.

    • WarmupPercentage — (Integer)

      The warm-up percentage that you want to associate with the dedicated IP address.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Enable or disable the Deliverability dashboard for your Amazon Pinpoint account. When you enable the Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests.

When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.

Examples:

Calling the putDeliverabilityDashboardOption operation

var params = {
  DashboardEnabled: true || false, /* required */
  SubscribedDomains: [
    {
      Domain: 'STRING_VALUE',
      InboxPlacementTrackingOption: {
        Global: true || false,
        TrackedIsps: [
          'STRING_VALUE',
          /* more items */
        ]
      },
      SubscriptionStartDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
    },
    /* more items */
  ]
};
pinpointemail.putDeliverabilityDashboardOption(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: {})
    • DashboardEnabled — (Boolean)

      Specifies whether to enable the Deliverability dashboard for your Amazon Pinpoint account. To enable the dashboard, set this value to true.

    • SubscribedDomains — (Array<map>)

      An array of objects, one for each verified domain that you use to send email and enabled the Deliverability dashboard for.

      • Domain — (String)

        A verified domain that’s associated with your AWS account and currently has an active Deliverability dashboard subscription.

      • SubscriptionStartDate — (Date)

        The date, in Unix time format, when you enabled the Deliverability dashboard for the domain.

      • InboxPlacementTrackingOption — (map)

        An object that contains information about the inbox placement data settings for the domain.

        • Global — (Boolean)

          Specifies whether inbox placement data is being tracked for the domain.

        • TrackedIsps — (Array<String>)

          An array of strings, one for each major email provider that the inbox placement data applies to.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Used to enable or disable DKIM authentication for an email identity.

Service Reference:

Examples:

Calling the putEmailIdentityDkimAttributes operation

var params = {
  EmailIdentity: 'STRING_VALUE', /* required */
  SigningEnabled: true || false
};
pinpointemail.putEmailIdentityDkimAttributes(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: {})
    • EmailIdentity — (String)

      The email identity that you want to change the DKIM settings for.

    • SigningEnabled — (Boolean)

      Sets the DKIM signing configuration for the identity.

      When you set this value true, then the messages that Amazon Pinpoint sends from the identity are DKIM-signed. When you set this value to false, then the messages that Amazon Pinpoint sends from the identity aren't DKIM-signed.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Used to enable or disable feedback forwarding for an identity. This setting determines what happens when an identity is used to send an email that results in a bounce or complaint event.

When you enable feedback forwarding, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email.

When you disable feedback forwarding, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic. You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).

Examples:

Calling the putEmailIdentityFeedbackAttributes operation

var params = {
  EmailIdentity: 'STRING_VALUE', /* required */
  EmailForwardingEnabled: true || false
};
pinpointemail.putEmailIdentityFeedbackAttributes(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: {})
    • EmailIdentity — (String)

      The email identity that you want to configure bounce and complaint feedback forwarding for.

    • EmailForwardingEnabled — (Boolean)

      Sets the feedback forwarding configuration for the identity.

      If the value is true, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email.

      When you set this value to false, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic or another event destination. You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Used to enable or disable the custom Mail-From domain configuration for an email identity.

Examples:

Calling the putEmailIdentityMailFromAttributes operation

var params = {
  EmailIdentity: 'STRING_VALUE', /* required */
  BehaviorOnMxFailure: USE_DEFAULT_VALUE | REJECT_MESSAGE,
  MailFromDomain: 'STRING_VALUE'
};
pinpointemail.putEmailIdentityMailFromAttributes(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: {})
    • EmailIdentity — (String)

      The verified email identity that you want to set up the custom MAIL FROM domain for.

    • MailFromDomain — (String)

      The custom MAIL FROM domain that you want the verified identity to use. The MAIL FROM domain must meet the following criteria:

      • It has to be a subdomain of the verified identity.

      • It can't be used to receive email.

      • It can't be used in a "From" address if the MAIL FROM domain is a destination for feedback forwarding emails.

    • BehaviorOnMxFailure — (String)

      The action that you want Amazon Pinpoint to take if it can't read the required MX record when you send an email. When you set this value to UseDefaultValue, Amazon Pinpoint uses amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage, Amazon Pinpoint returns a MailFromDomainNotVerified error, and doesn't attempt to deliver the email.

      These behaviors are taken when the custom MAIL FROM domain configuration is in the Pending, Failed, and TemporaryFailure states.

      Possible values include:
      • "USE_DEFAULT_VALUE"
      • "REJECT_MESSAGE"

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Sends an email message. You can use the Amazon Pinpoint Email API to send two types of messages:

  • Simple – A standard email message. When you create this type of message, you specify the sender, the recipient, and the message body, and Amazon Pinpoint assembles the message for you.

  • Raw – A raw, MIME-formatted email message. When you send this type of email, you have to specify all of the message headers, as well as the message body. You can use this message type to send messages that contain attachments. The message that you specify has to be a valid MIME message.

Service Reference:

Examples:

Calling the sendEmail operation

var params = {
  Content: { /* required */
    Raw: {
      Data: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */ /* required */
    },
    Simple: {
      Body: { /* required */
        Html: {
          Data: 'STRING_VALUE', /* required */
          Charset: 'STRING_VALUE'
        },
        Text: {
          Data: 'STRING_VALUE', /* required */
          Charset: 'STRING_VALUE'
        }
      },
      Subject: { /* required */
        Data: 'STRING_VALUE', /* required */
        Charset: 'STRING_VALUE'
      }
    }
  },
  Destination: { /* required */
    BccAddresses: [
      'STRING_VALUE',
      /* more items */
    ],
    CcAddresses: [
      'STRING_VALUE',
      /* more items */
    ],
    ToAddresses: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  ConfigurationSetName: 'STRING_VALUE',
  EmailTags: [
    {
      Name: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  FeedbackForwardingEmailAddress: 'STRING_VALUE',
  FromEmailAddress: 'STRING_VALUE',
  ReplyToAddresses: [
    'STRING_VALUE',
    /* more items */
  ]
};
pinpointemail.sendEmail(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: {})
    • FromEmailAddress — (String)

      The email address that you want to use as the "From" address for the email. The address that you specify has to be verified.

    • Destination — (map)

      An object that contains the recipients of the email message.

      • ToAddresses — (Array<String>)

        An array that contains the email addresses of the "To" recipients for the email.

      • CcAddresses — (Array<String>)

        An array that contains the email addresses of the "CC" (carbon copy) recipients for the email.

      • BccAddresses — (Array<String>)

        An array that contains the email addresses of the "BCC" (blind carbon copy) recipients for the email.

    • ReplyToAddresses — (Array<String>)

      The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.

    • FeedbackForwardingEmailAddress — (String)

      The address that Amazon Pinpoint should send bounce and complaint notifications to.

    • Content — (map)

      An object that contains the body of the message. You can send either a Simple message or a Raw message.

      • Simple — (map)

        The simple email message. The message consists of a subject and a message body.

        • Subjectrequired — (map)

          The subject line of the email. The subject line can only contain 7-bit ASCII characters. However, you can specify non-ASCII characters in the subject line by using encoded-word syntax, as described in RFC 2047.

          • Datarequired — (String)

            The content of the message itself.

          • Charset — (String)

            The character set for the content. Because of the constraints of the SMTP protocol, Amazon Pinpoint uses 7-bit ASCII by default. If the text includes characters outside of the ASCII range, you have to specify a character set. For example, you could specify UTF-8, ISO-8859-1, or Shift_JIS.

        • Bodyrequired — (map)

          The body of the message. You can specify an HTML version of the message, a text-only version of the message, or both.

          • Text — (map)

            An object that represents the version of the message that is displayed in email clients that don't support HTML, or clients where the recipient has disabled HTML rendering.

            • Datarequired — (String)

              The content of the message itself.

            • Charset — (String)

              The character set for the content. Because of the constraints of the SMTP protocol, Amazon Pinpoint uses 7-bit ASCII by default. If the text includes characters outside of the ASCII range, you have to specify a character set. For example, you could specify UTF-8, ISO-8859-1, or Shift_JIS.

          • Html — (map)

            An object that represents the version of the message that is displayed in email clients that support HTML. HTML messages can include formatted text, hyperlinks, images, and more.

            • Datarequired — (String)

              The content of the message itself.

            • Charset — (String)

              The character set for the content. Because of the constraints of the SMTP protocol, Amazon Pinpoint uses 7-bit ASCII by default. If the text includes characters outside of the ASCII range, you have to specify a character set. For example, you could specify UTF-8, ISO-8859-1, or Shift_JIS.

      • Raw — (map)

        The raw email message. The message has to meet the following criteria:

        • The message has to contain a header and a body, separated by one blank line.

        • All of the required header fields must be present in the message.

        • Each part of a multipart MIME message must be formatted properly.

        • If you include attachments, they must be in a file format that Amazon Pinpoint supports.

        • The entire message must be Base64 encoded.

        • If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, you should encode that content to ensure that recipients' email clients render the message properly.

        • The length of any single line of text in the message can't exceed 1,000 characters. This restriction is defined in RFC 5321.

        • Datarequired — (Buffer, Typed Array, Blob, String)

          The raw email message. The message has to meet the following criteria:

          • The message has to contain a header and a body, separated by one blank line.

          • All of the required header fields must be present in the message.

          • Each part of a multipart MIME message must be formatted properly.

          • Attachments must be in a file format that Amazon Pinpoint supports.

          • The entire message must be Base64 encoded.

          • If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, you should encode that content to ensure that recipients' email clients render the message properly.

          • The length of any single line of text in the message can't exceed 1,000 characters. This restriction is defined in RFC 5321.

    • EmailTags — (Array<map>)

      A list of tags, in the form of name/value pairs, to apply to an email that you send using the SendEmail operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

      • Namerequired — (String)

        The name of the message tag. The message tag name has to meet the following criteria:

        • It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).

        • It can contain no more than 256 characters.

      • Valuerequired — (String)

        The value of the message tag. The message tag value has to meet the following criteria:

        • It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).

        • It can contain no more than 256 characters.

    • ConfigurationSetName — (String)

      The name of the configuration set that you want to use when sending the email.

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:

      • MessageId — (String)

        A unique identifier for the message that is generated when Amazon Pinpoint accepts the message.

        Note: It is possible for Amazon Pinpoint to accept a message without sending it. This can happen when the message you're trying to send has an attachment doesn't pass a virus check, or when you send a templated email that contains invalid personalization content, for example.

Returns:

  • (AWS.Request)

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

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

Add one or more tags (keys and values) to a specified resource. A tag is a label that you optionally define and associate with a resource in Amazon Pinpoint. Tags can help you categorize and manage resources in different ways, such as by purpose, owner, environment, or other criteria. A resource can have as many as 50 tags.

Each tag consists of a required tag key and an associated tag value, both of which you define. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key.

Service Reference:

Examples:

Calling the tagResource operation

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

Parameters:

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

      The Amazon Resource Name (ARN) of the resource that you want to add one or more tags to.

    • Tags — (Array<map>)

      A list of the tags that you want to add to the resource. A tag consists of a required tag key (Key) and an associated tag value (Value). The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

      • Keyrequired — (String)

        One part of a key-value pair that defines a tag. The maximum length of a tag key is 128 characters. The minimum length is 1 character.

      • Valuerequired — (String)

        The optional part of a key-value pair that defines a tag. The maximum length of a tag value is 256 characters. The minimum length is 0 characters. If you don’t want a resource to have a specific tag value, don’t specify a value for this parameter. Amazon Pinpoint will set the value to an empty string.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Remove one or more tags (keys and values) from a specified resource.

Service Reference:

Examples:

Calling the untagResource operation

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

Parameters:

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

      The Amazon Resource Name (ARN) of the resource that you want to remove one or more tags from.

    • TagKeys — (Array<String>)

      The tags (tag keys) that you want to remove from the resource. When you specify a tag key, the action removes both that key and its associated tag value.

      To remove more than one tag from the resource, append the TagKeys parameter and argument for each additional tag to remove, separated by an ampersand. For example: /v1/email/tags?ResourceArn=ResourceArn&TagKeys=Key1&TagKeys=Key2

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Update the configuration of an event destination for a configuration set.

In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.

Examples:

Calling the updateConfigurationSetEventDestination operation

var params = {
  ConfigurationSetName: 'STRING_VALUE', /* required */
  EventDestination: { /* required */
    CloudWatchDestination: {
      DimensionConfigurations: [ /* required */
        {
          DefaultDimensionValue: 'STRING_VALUE', /* required */
          DimensionName: 'STRING_VALUE', /* required */
          DimensionValueSource: MESSAGE_TAG | EMAIL_HEADER | LINK_TAG /* required */
        },
        /* more items */
      ]
    },
    Enabled: true || false,
    KinesisFirehoseDestination: {
      DeliveryStreamArn: 'STRING_VALUE', /* required */
      IamRoleArn: 'STRING_VALUE' /* required */
    },
    MatchingEventTypes: [
      SEND | REJECT | BOUNCE | COMPLAINT | DELIVERY | OPEN | CLICK | RENDERING_FAILURE,
      /* more items */
    ],
    PinpointDestination: {
      ApplicationArn: 'STRING_VALUE'
    },
    SnsDestination: {
      TopicArn: 'STRING_VALUE' /* required */
    }
  },
  EventDestinationName: 'STRING_VALUE' /* required */
};
pinpointemail.updateConfigurationSetEventDestination(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: {})
    • ConfigurationSetName — (String)

      The name of the configuration set that contains the event destination that you want to modify.

    • EventDestinationName — (String)

      The name of the event destination that you want to modify.

    • EventDestination — (map)

      An object that defines the event destination.

      • Enabled — (Boolean)

        If true, the event destination is enabled. When the event destination is enabled, the specified event types are sent to the destinations in this EventDestinationDefinition.

        If false, the event destination is disabled. When the event destination is disabled, events aren't sent to the specified destinations.

      • MatchingEventTypes — (Array<String>)

        An array that specifies which events Amazon Pinpoint should send to the destinations in this EventDestinationDefinition.

      • KinesisFirehoseDestination — (map)

        An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.

        • IamRoleArnrequired — (String)

          The Amazon Resource Name (ARN) of the IAM role that Amazon Pinpoint uses when sending email events to the Amazon Kinesis Data Firehose stream.

        • DeliveryStreamArnrequired — (String)

          The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose stream that Amazon Pinpoint sends email events to.

      • CloudWatchDestination — (map)

        An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics.

        • DimensionConfigurationsrequired — (Array<map>)

          An array of objects that define the dimensions to use when you send email events to Amazon CloudWatch.

          • DimensionNamerequired — (String)

            The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria:

            • It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

            • It can contain no more than 256 characters.

          • DimensionValueSourcerequired — (String)

            The location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon Pinpoint to use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail/SendRawEmail API, choose messageTag. If you want Amazon Pinpoint to use your own email headers, choose emailHeader. If you want Amazon Pinpoint to use link tags, choose linkTags.

            Possible values include:
            • "MESSAGE_TAG"
            • "EMAIL_HEADER"
            • "LINK_TAG"
          • DefaultDimensionValuerequired — (String)

            The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email. This value has to meet the following criteria:

            • It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

            • It can contain no more than 256 characters.

      • SnsDestination — (map)

        An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.

        • TopicArnrequired — (String)

          The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish email events to. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

      • PinpointDestination — (map)

        An object that defines a Amazon Pinpoint destination for email events. You can use Amazon Pinpoint events to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments for your campaigns.

        • ApplicationArn — (String)

          The Amazon Resource Name (ARN) of the Amazon Pinpoint project that you want to send email events to.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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