Note: You are viewing the documentation for an older major version of the AWS SDK for JavaScript (v2).

The modular AWS SDK for JavaScript (v3) is now General Available. For more information see the Developer Guide or API Reference.

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: AWS.CustomerProfiles

Inherits:
AWS.Service show all
Identifier:
customerprofiles
API Version:
2020-08-15
Defined in:
(unknown)

Overview

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

Service Description

Welcome to the Amazon Connect Customer Profiles API Reference. This guide provides information about the Amazon Connect Customer Profiles API, including supported operations, data types, parameters, and schemas.

Amazon Connect Customer Profiles is a unified customer profile for your contact center that has pre-built connectors powered by AppFlow that make it easy to combine customer information from third party applications, such as Salesforce (CRM), ServiceNow (ITSM), and your enterprise resource planning (ERP), with contact history from your Amazon Connect contact center.

If you're new to Amazon Connect , you might find it helpful to also review the Amazon Connect Administrator Guide.

Sending a Request Using CustomerProfiles

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

var customerprofiles = new AWS.CustomerProfiles({apiVersion: '2020-08-15'});

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

AWS.config.apiVersions = {
  customerprofiles: '2020-08-15',
  // other service API versions
};

var customerprofiles = new AWS.CustomerProfiles();

Version:

  • 2020-08-15

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

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

Examples:

Constructing a CustomerProfiles object

var customerprofiles = new AWS.CustomerProfiles({apiVersion: '2020-08-15'});

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|AWS.Endpoint)

    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' or an Endpoint object.

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

  • maxRetries (Integer)

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

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.CustomerProfiles.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.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

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

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • 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|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

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

  • hostPrefixEnabled (Boolean)

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

  • stsRegionalEndpoints ('legacy'|'regional')

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

Property Details

endpointAWS.Endpoint (readwrite)

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

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

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

Associates a new key value with a specific profile, such as a Contact Trace Record (CTR) ContactId.

A profile object can have a single unique key and any number of additional keys that can be used to identify the profile that it belongs to.

Service Reference:

Examples:

Calling the addProfileKey operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  KeyName: 'STRING_VALUE', /* required */
  ProfileId: 'STRING_VALUE', /* required */
  Values: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
customerprofiles.addProfileKey(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: {})
    • ProfileId — (String)

      The unique identifier of a customer profile.

    • KeyName — (String)

      A searchable identifier of a customer profile.

    • Values — (Array<String>)

      A list of key values.

    • DomainName — (String)

      The unique name of the domain.

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:

      • KeyName — (String)

        A searchable identifier of a customer profile.

      • Values — (Array<String>)

        A list of key values.

Returns:

  • (AWS.Request)

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

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

Creates a domain, which is a container for all customer data, such as customer profile attributes, object types, profile keys, and encryption keys. You can create multiple domains, and each domain can have multiple third-party integrations.

Each Amazon Connect instance can be associated with only one domain. Multiple Amazon Connect instances can be associated with one domain.

Service Reference:

Examples:

Calling the createDomain operation

var params = {
  DefaultExpirationDays: 'NUMBER_VALUE', /* required */
  DomainName: 'STRING_VALUE', /* required */
  DeadLetterQueueUrl: 'STRING_VALUE',
  DefaultEncryptionKey: 'STRING_VALUE',
  Matching: {
    Enabled: true || false /* required */
  },
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
customerprofiles.createDomain(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: {})
    • DomainName — (String)

      The unique name of the domain.

    • DefaultExpirationDays — (Integer)

      The default number of days until the data within the domain expires.

    • DefaultEncryptionKey — (String)

      The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage.

    • DeadLetterQueueUrl — (String)

      The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications. You must set up a policy on the DeadLetterQueue for the SendMessage operation to enable Amazon Connect Customer Profiles to send messages to the DeadLetterQueue.

    • Matching — (map)

      The process of matching duplicate profiles. This process runs every Saturday at 12AM.

      • Enabledrequired — (Boolean)

        The flag that enables the matching process of duplicate profiles.

    • Tags — (map<String>)

      The tags used to organize, track, or control access for this resource.

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:

      • DomainName — (String)

        The unique name of the domain.

      • DefaultExpirationDays — (Integer)

        The default number of days until the data within the domain expires.

      • DefaultEncryptionKey — (String)

        The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage.

      • DeadLetterQueueUrl — (String)

        The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.

      • Matching — (map)

        The process of matching duplicate profiles. This process runs every Saturday at 12AM.

        • Enabled — (Boolean)

          The flag that enables the matching process of duplicate profiles.

      • CreatedAt — (Date)

        The timestamp of when the domain was created.

      • LastUpdatedAt — (Date)

        The timestamp of when the domain was most recently edited.

      • Tags — (map<String>)

        The tags used to organize, track, or control access for this resource.

Returns:

  • (AWS.Request)

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

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

Creates a standard profile.

A standard profile represents the following attributes for a customer profile in a domain.

Service Reference:

Examples:

Calling the createProfile operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  AccountNumber: 'STRING_VALUE',
  AdditionalInformation: 'STRING_VALUE',
  Address: {
    Address1: 'STRING_VALUE',
    Address2: 'STRING_VALUE',
    Address3: 'STRING_VALUE',
    Address4: 'STRING_VALUE',
    City: 'STRING_VALUE',
    Country: 'STRING_VALUE',
    County: 'STRING_VALUE',
    PostalCode: 'STRING_VALUE',
    Province: 'STRING_VALUE',
    State: 'STRING_VALUE'
  },
  Attributes: {
    '<string1To255>': 'STRING_VALUE',
    /* '<string1To255>': ... */
  },
  BillingAddress: {
    Address1: 'STRING_VALUE',
    Address2: 'STRING_VALUE',
    Address3: 'STRING_VALUE',
    Address4: 'STRING_VALUE',
    City: 'STRING_VALUE',
    Country: 'STRING_VALUE',
    County: 'STRING_VALUE',
    PostalCode: 'STRING_VALUE',
    Province: 'STRING_VALUE',
    State: 'STRING_VALUE'
  },
  BirthDate: 'STRING_VALUE',
  BusinessEmailAddress: 'STRING_VALUE',
  BusinessName: 'STRING_VALUE',
  BusinessPhoneNumber: 'STRING_VALUE',
  EmailAddress: 'STRING_VALUE',
  FirstName: 'STRING_VALUE',
  Gender: MALE | FEMALE | UNSPECIFIED,
  HomePhoneNumber: 'STRING_VALUE',
  LastName: 'STRING_VALUE',
  MailingAddress: {
    Address1: 'STRING_VALUE',
    Address2: 'STRING_VALUE',
    Address3: 'STRING_VALUE',
    Address4: 'STRING_VALUE',
    City: 'STRING_VALUE',
    Country: 'STRING_VALUE',
    County: 'STRING_VALUE',
    PostalCode: 'STRING_VALUE',
    Province: 'STRING_VALUE',
    State: 'STRING_VALUE'
  },
  MiddleName: 'STRING_VALUE',
  MobilePhoneNumber: 'STRING_VALUE',
  PartyType: INDIVIDUAL | BUSINESS | OTHER,
  PersonalEmailAddress: 'STRING_VALUE',
  PhoneNumber: 'STRING_VALUE',
  ShippingAddress: {
    Address1: 'STRING_VALUE',
    Address2: 'STRING_VALUE',
    Address3: 'STRING_VALUE',
    Address4: 'STRING_VALUE',
    City: 'STRING_VALUE',
    Country: 'STRING_VALUE',
    County: 'STRING_VALUE',
    PostalCode: 'STRING_VALUE',
    Province: 'STRING_VALUE',
    State: 'STRING_VALUE'
  }
};
customerprofiles.createProfile(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: {})
    • DomainName — (String)

      The unique name of the domain.

    • AccountNumber — (String)

      A unique account number that you have given to the customer.

    • AdditionalInformation — (String)

      Any additional information relevant to the customer’s profile.

    • PartyType — (String)

      The type of profile used to describe the customer.

      Possible values include:
      • "INDIVIDUAL"
      • "BUSINESS"
      • "OTHER"
    • BusinessName — (String)

      The name of the customer’s business.

    • FirstName — (String)

      The customer’s first name.

    • MiddleName — (String)

      The customer’s middle name.

    • LastName — (String)

      The customer’s last name.

    • BirthDate — (String)

      The customer’s birth date.

    • Gender — (String)

      The gender with which the customer identifies.

      Possible values include:
      • "MALE"
      • "FEMALE"
      • "UNSPECIFIED"
    • PhoneNumber — (String)

      The customer’s phone number, which has not been specified as a mobile, home, or business number.

    • MobilePhoneNumber — (String)

      The customer’s mobile phone number.

    • HomePhoneNumber — (String)

      The customer’s home phone number.

    • BusinessPhoneNumber — (String)

      The customer’s business phone number.

    • EmailAddress — (String)

      The customer’s email address, which has not been specified as a personal or business address.

    • PersonalEmailAddress — (String)

      The customer’s personal email address.

    • BusinessEmailAddress — (String)

      The customer’s business email address.

    • Address — (map)

      A generic address associated with the customer that is not mailing, shipping, or billing.

      • Address1 — (String)

        The first line of a customer address.

      • Address2 — (String)

        The second line of a customer address.

      • Address3 — (String)

        The third line of a customer address.

      • Address4 — (String)

        The fourth line of a customer address.

      • City — (String)

        The city in which a customer lives.

      • County — (String)

        The county in which a customer lives.

      • State — (String)

        The state in which a customer lives.

      • Province — (String)

        The province in which a customer lives.

      • Country — (String)

        The country in which a customer lives.

      • PostalCode — (String)

        The postal code of a customer address.

    • ShippingAddress — (map)

      The customer’s shipping address.

      • Address1 — (String)

        The first line of a customer address.

      • Address2 — (String)

        The second line of a customer address.

      • Address3 — (String)

        The third line of a customer address.

      • Address4 — (String)

        The fourth line of a customer address.

      • City — (String)

        The city in which a customer lives.

      • County — (String)

        The county in which a customer lives.

      • State — (String)

        The state in which a customer lives.

      • Province — (String)

        The province in which a customer lives.

      • Country — (String)

        The country in which a customer lives.

      • PostalCode — (String)

        The postal code of a customer address.

    • MailingAddress — (map)

      The customer’s mailing address.

      • Address1 — (String)

        The first line of a customer address.

      • Address2 — (String)

        The second line of a customer address.

      • Address3 — (String)

        The third line of a customer address.

      • Address4 — (String)

        The fourth line of a customer address.

      • City — (String)

        The city in which a customer lives.

      • County — (String)

        The county in which a customer lives.

      • State — (String)

        The state in which a customer lives.

      • Province — (String)

        The province in which a customer lives.

      • Country — (String)

        The country in which a customer lives.

      • PostalCode — (String)

        The postal code of a customer address.

    • BillingAddress — (map)

      The customer’s billing address.

      • Address1 — (String)

        The first line of a customer address.

      • Address2 — (String)

        The second line of a customer address.

      • Address3 — (String)

        The third line of a customer address.

      • Address4 — (String)

        The fourth line of a customer address.

      • City — (String)

        The city in which a customer lives.

      • County — (String)

        The county in which a customer lives.

      • State — (String)

        The state in which a customer lives.

      • Province — (String)

        The province in which a customer lives.

      • Country — (String)

        The country in which a customer lives.

      • PostalCode — (String)

        The postal code of a customer address.

    • Attributes — (map<String>)

      A key value pair of attributes of a customer profile.

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:

      • ProfileId — (String)

        The unique identifier of a customer profile.

Returns:

  • (AWS.Request)

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

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

Deletes a specific domain and all of its customer data, such as customer profile attributes and their related objects.

Service Reference:

Examples:

Calling the deleteDomain operation

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

      The unique name of the domain.

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:

      • Message — (String)

        A message that indicates the delete request is done.

Returns:

  • (AWS.Request)

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

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

Removes an integration from a specific domain.

Service Reference:

Examples:

Calling the deleteIntegration operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  Uri: 'STRING_VALUE' /* required */
};
customerprofiles.deleteIntegration(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: {})
    • DomainName — (String)

      The unique name of the domain.

    • Uri — (String)

      The URI of the S3 bucket or any other type of data source.

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:

      • Message — (String)

        A message that indicates the delete request is done.

Returns:

  • (AWS.Request)

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

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

Deletes the standard customer profile and all data pertaining to the profile.

Service Reference:

Examples:

Calling the deleteProfile operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  ProfileId: 'STRING_VALUE' /* required */
};
customerprofiles.deleteProfile(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: {})
    • ProfileId — (String)

      The unique identifier of a customer profile.

    • DomainName — (String)

      The unique name of the domain.

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:

      • Message — (String)

        A message that indicates the delete request is done.

Returns:

  • (AWS.Request)

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

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

Removes a searchable key from a customer profile.

Service Reference:

Examples:

Calling the deleteProfileKey operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  KeyName: 'STRING_VALUE', /* required */
  ProfileId: 'STRING_VALUE', /* required */
  Values: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
customerprofiles.deleteProfileKey(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: {})
    • ProfileId — (String)

      The unique identifier of a customer profile.

    • KeyName — (String)

      A searchable identifier of a customer profile.

    • Values — (Array<String>)

      A list of key values.

    • DomainName — (String)

      The unique name of the domain.

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:

      • Message — (String)

        A message that indicates the delete request is done.

Returns:

  • (AWS.Request)

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

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

Removes an object associated with a profile of a given ProfileObjectType.

Service Reference:

Examples:

Calling the deleteProfileObject operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  ObjectTypeName: 'STRING_VALUE', /* required */
  ProfileId: 'STRING_VALUE', /* required */
  ProfileObjectUniqueKey: 'STRING_VALUE' /* required */
};
customerprofiles.deleteProfileObject(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: {})
    • ProfileId — (String)

      The unique identifier of a customer profile.

    • ProfileObjectUniqueKey — (String)

      The unique identifier of the profile object generated by the service.

    • ObjectTypeName — (String)

      The name of the profile object type.

    • DomainName — (String)

      The unique name of the domain.

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:

      • Message — (String)

        A message that indicates the delete request is done.

Returns:

  • (AWS.Request)

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

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

Removes a ProfileObjectType from a specific domain as well as removes all the ProfileObjects of that type. It also disables integrations from this specific ProfileObjectType. In addition, it scrubs all of the fields of the standard profile that were populated from this ProfileObjectType.

Service Reference:

Examples:

Calling the deleteProfileObjectType operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  ObjectTypeName: 'STRING_VALUE' /* required */
};
customerprofiles.deleteProfileObjectType(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: {})
    • DomainName — (String)

      The unique name of the domain.

    • ObjectTypeName — (String)

      The name of the profile object type.

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:

      • Message — (String)

        A message that indicates the delete request is done.

Returns:

  • (AWS.Request)

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

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

Returns information about a specific domain.

Service Reference:

Examples:

Calling the getDomain operation

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

      The unique name of the domain.

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:

      • DomainName — (String)

        The unique name of the domain.

      • DefaultExpirationDays — (Integer)

        The default number of days until the data within the domain expires.

      • DefaultEncryptionKey — (String)

        The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage.

      • DeadLetterQueueUrl — (String)

        The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.

      • Stats — (map)

        Usage-specific statistics about the domain.

        • ProfileCount — (Integer)

          The total number of profiles currently in the domain.

        • MeteringProfileCount — (Integer)

          The number of profiles that you are currently paying for in the domain. If you have more than 100 objects associated with a single profile, that profile counts as two profiles. If you have more than 200 objects, that profile counts as three, and so on.

        • ObjectCount — (Integer)

          The total number of objects in domain.

        • TotalSize — (Integer)

          The total size, in bytes, of all objects in the domain.

      • Matching — (map)

        The process of matching duplicate profiles. This process runs every Saturday at 12AM.

        • Enabled — (Boolean)

          The flag that enables the matching process of duplicate profiles.

      • CreatedAt — (Date)

        The timestamp of when the domain was created.

      • LastUpdatedAt — (Date)

        The timestamp of when the domain was most recently edited.

      • Tags — (map<String>)

        The tags used to organize, track, or control access for this resource.

Returns:

  • (AWS.Request)

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

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

Returns an integration for a domain.

Service Reference:

Examples:

Calling the getIntegration operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  Uri: 'STRING_VALUE' /* required */
};
customerprofiles.getIntegration(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: {})
    • DomainName — (String)

      The unique name of the domain.

    • Uri — (String)

      The URI of the S3 bucket or any other type of data source.

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:

      • DomainName — (String)

        The unique name of the domain.

      • Uri — (String)

        The URI of the S3 bucket or any other type of data source.

      • ObjectTypeName — (String)

        The name of the profile object type.

      • CreatedAt — (Date)

        The timestamp of when the domain was created.

      • LastUpdatedAt — (Date)

        The timestamp of when the domain was most recently edited.

      • Tags — (map<String>)

        The tags used to organize, track, or control access for this resource.

Returns:

  • (AWS.Request)

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

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

This API is in preview release for Amazon Connect and subject to change.

Before calling this API, use CreateDomain or UpdateDomain to enable identity resolution: set Matching to true.

GetMatches returns potentially matching profiles, based on the results of the latest run of a machine learning process.

Amazon Connect runs a batch process every Saturday at 12AM UTC to identify matching profiles. The results are returned up to seven days after the Saturday run.

Amazon Connect uses the following profile attributes to identify matches:

  • PhoneNumber

  • HomePhoneNumber

  • BusinessPhoneNumber

  • MobilePhoneNumber

  • EmailAddress

  • PersonalEmailAddress

  • BusinessEmailAddress

  • FullName

  • BusinessName

Service Reference:

Examples:

Calling the getMatches operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
customerprofiles.getMatches(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)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    • MaxResults — (Integer)

      The maximum number of results to return per page.

    • DomainName — (String)

      The unique name of the domain.

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:

      • NextToken — (String)

        If there are additional results, this is the token for the next set of results.

      • MatchGenerationDate — (Date)

        The timestamp this version of Match Result generated.

      • PotentialMatches — (Integer)

        The number of potential matches found.

      • Matches — (Array<map>)

        The list of matched profiles for this instance.

        • MatchId — (String)

          The unique identifiers for this group of profiles that match.

        • ProfileIds — (Array<String>)

          A list of identifiers for profiles that match.

Returns:

  • (AWS.Request)

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

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

Returns the object types for a specific domain.

Service Reference:

Examples:

Calling the getProfileObjectType operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  ObjectTypeName: 'STRING_VALUE' /* required */
};
customerprofiles.getProfileObjectType(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: {})
    • DomainName — (String)

      The unique name of the domain.

    • ObjectTypeName — (String)

      The name of the profile object type.

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:

      • ObjectTypeName — (String)

        The name of the profile object type.

      • Description — (String)

        The description of the profile object type.

      • TemplateId — (String)

        A unique identifier for the object template.

      • ExpirationDays — (Integer)

        The number of days until the data in the object expires.

      • EncryptionKey — (String)

        The customer-provided key to encrypt the profile object that will be created in this profile object type.

      • AllowProfileCreation — (Boolean)

        Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. The default is FALSE. If the AllowProfileCreation flag is set to FALSE, then the service tries to fetch a standard profile and associate this object with the profile. If it is set to TRUE, and if no match is found, then the service creates a new standard profile.

      • Fields — (map<map>)

        A map of the name and ObjectType field.

        • Source — (String)

          A field of a ProfileObject. For example: source.FirstName, where “source” is a ProfileObjectType of a Zendesk user and “FirstName” is a field in that ObjectType.

        • Target — (String)

          The location of the data in the standard ProfileObject model. For example: _profile.Address.PostalCode.

        • ContentType — (String)

          The content type of the field. Used for determining equality when searching.

          Possible values include:
          • "STRING"
          • "NUMBER"
          • "PHONE_NUMBER"
          • "EMAIL_ADDRESS"
          • "NAME"
      • Keys — (map<Array<map>>)

        A list of unique keys that can be used to map data to the profile.

        • StandardIdentifiers — (Array<String>)

          The types of keys that a ProfileObject can have. Each ProfileObject can have only 1 UNIQUE key but multiple PROFILE keys. PROFILE means that this key can be used to tie an object to a PROFILE. UNIQUE means that it can be used to uniquely identify an object. If a key a is marked as SECONDARY, it will be used to search for profiles after all other PROFILE keys have been searched. A LOOKUP_ONLY key is only used to match a profile but is not persisted to be used for searching of the profile. A NEW_ONLY key is only used if the profile does not already exist before the object is ingested, otherwise it is only used for matching objects to profiles.

        • FieldNames — (Array<String>)

          The reference for the key name of the fields map.

      • CreatedAt — (Date)

        The timestamp of when the domain was created.

      • LastUpdatedAt — (Date)

        The timestamp of when the domain was most recently edited.

      • Tags — (map<String>)

        The tags used to organize, track, or control access for this resource.

Returns:

  • (AWS.Request)

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

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

Returns the template information for a specific object type.

A template is a predefined ProfileObjectType, such as “Salesforce-Account” or “Salesforce-Contact.” When a user sends a ProfileObject, using the PutProfileObject API, with an ObjectTypeName that matches one of the TemplateIds, it uses the mappings from the template.

Service Reference:

Examples:

Calling the getProfileObjectTypeTemplate operation

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

      A unique identifier for the object template.

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:

      • TemplateId — (String)

        A unique identifier for the object template.

      • SourceName — (String)

        The name of the source of the object template.

      • SourceObject — (String)

        The source of the object template.

      • AllowProfileCreation — (Boolean)

        Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. The default is FALSE. If the AllowProfileCreation flag is set to FALSE, then the service tries to fetch a standard profile and associate this object with the profile. If it is set to TRUE, and if no match is found, then the service creates a new standard profile.

      • Fields — (map<map>)

        A map of the name and ObjectType field.

        • Source — (String)

          A field of a ProfileObject. For example: source.FirstName, where “source” is a ProfileObjectType of a Zendesk user and “FirstName” is a field in that ObjectType.

        • Target — (String)

          The location of the data in the standard ProfileObject model. For example: _profile.Address.PostalCode.

        • ContentType — (String)

          The content type of the field. Used for determining equality when searching.

          Possible values include:
          • "STRING"
          • "NUMBER"
          • "PHONE_NUMBER"
          • "EMAIL_ADDRESS"
          • "NAME"
      • Keys — (map<Array<map>>)

        A list of unique keys that can be used to map data to the profile.

        • StandardIdentifiers — (Array<String>)

          The types of keys that a ProfileObject can have. Each ProfileObject can have only 1 UNIQUE key but multiple PROFILE keys. PROFILE means that this key can be used to tie an object to a PROFILE. UNIQUE means that it can be used to uniquely identify an object. If a key a is marked as SECONDARY, it will be used to search for profiles after all other PROFILE keys have been searched. A LOOKUP_ONLY key is only used to match a profile but is not persisted to be used for searching of the profile. A NEW_ONLY key is only used if the profile does not already exist before the object is ingested, otherwise it is only used for matching objects to profiles.

        • FieldNames — (Array<String>)

          The reference for the key name of the fields map.

Returns:

  • (AWS.Request)

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

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

Lists all of the integrations associated to a specific URI in the AWS account.

Service Reference:

Examples:

Calling the listAccountIntegrations operation

var params = {
  Uri: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
customerprofiles.listAccountIntegrations(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: {})
    • Uri — (String)

      The URI of the S3 bucket or any other type of data source.

    • NextToken — (String)

      The pagination token from the previous ListAccountIntegrations API call.

    • MaxResults — (Integer)

      The maximum number of objects returned per page.

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:

      • Items — (Array<map>)

        The list of ListAccountIntegration instances.

        • DomainNamerequired — (String)

          The unique name of the domain.

        • Urirequired — (String)

          The URI of the S3 bucket or any other type of data source.

        • ObjectTypeNamerequired — (String)

          The name of the profile object type.

        • CreatedAtrequired — (Date)

          The timestamp of when the domain was created.

        • LastUpdatedAtrequired — (Date)

          The timestamp of when the domain was most recently edited.

        • Tags — (map<String>)

          The tags used to organize, track, or control access for this resource.

      • NextToken — (String)

        The pagination token from the previous ListAccountIntegrations API call.

Returns:

  • (AWS.Request)

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

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

Returns a list of all the domains for an AWS account that have been created.

Service Reference:

Examples:

Calling the listDomains operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
customerprofiles.listDomains(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)

      The pagination token from the previous ListDomain API call.

    • MaxResults — (Integer)

      The maximum number of objects returned per page.

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:

      • Items — (Array<map>)

        The list of ListDomains instances.

        • DomainNamerequired — (String)

          The unique name of the domain.

        • CreatedAtrequired — (Date)

          The timestamp of when the domain was created.

        • LastUpdatedAtrequired — (Date)

          The timestamp of when the domain was most recently edited.

        • Tags — (map<String>)

          The tags used to organize, track, or control access for this resource.

      • NextToken — (String)

        The pagination token from the previous ListDomains API call.

Returns:

  • (AWS.Request)

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

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

Lists all of the integrations in your domain.

Service Reference:

Examples:

Calling the listIntegrations operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
customerprofiles.listIntegrations(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: {})
    • DomainName — (String)

      The unique name of the domain.

    • NextToken — (String)

      The pagination token from the previous ListIntegrations API call.

    • MaxResults — (Integer)

      The maximum number of objects returned per page.

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:

      • Items — (Array<map>)

        The list of ListIntegrations instances.

        • DomainNamerequired — (String)

          The unique name of the domain.

        • Urirequired — (String)

          The URI of the S3 bucket or any other type of data source.

        • ObjectTypeNamerequired — (String)

          The name of the profile object type.

        • CreatedAtrequired — (Date)

          The timestamp of when the domain was created.

        • LastUpdatedAtrequired — (Date)

          The timestamp of when the domain was most recently edited.

        • Tags — (map<String>)

          The tags used to organize, track, or control access for this resource.

      • NextToken — (String)

        The pagination token from the previous ListIntegrations API call.

Returns:

  • (AWS.Request)

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

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

Returns a list of objects associated with a profile of a given ProfileObjectType.

Service Reference:

Examples:

Calling the listProfileObjects operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  ObjectTypeName: 'STRING_VALUE', /* required */
  ProfileId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
customerprofiles.listProfileObjects(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)

      The pagination token from the previous call to ListProfileObjects.

    • MaxResults — (Integer)

      The maximum number of objects returned per page.

    • DomainName — (String)

      The unique name of the domain.

    • ObjectTypeName — (String)

      The name of the profile object type.

    • ProfileId — (String)

      The unique identifier of a customer profile.

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:

      • Items — (Array<map>)

        The list of ListProfileObject instances.

        • ObjectTypeName — (String)

          Specifies the kind of object being added to a profile, such as "Salesforce-Account."

        • ProfileObjectUniqueKey — (String)

          The unique identifier of the ProfileObject generated by the service.

        • Object — (String)

          A JSON representation of a ProfileObject that belongs to a profile.

      • NextToken — (String)

        The pagination token from the previous call to ListProfileObjects.

Returns:

  • (AWS.Request)

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

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

Lists all of the templates available within the service.

Service Reference:

Examples:

Calling the listProfileObjectTypes operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
customerprofiles.listProfileObjectTypes(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: {})
    • DomainName — (String)

      The unique name of the domain.

    • NextToken — (String)

      Identifies the next page of results to return.

    • MaxResults — (Integer)

      The maximum number of objects returned per page.

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:

      • Items — (Array<map>)

        The list of ListProfileObjectTypes instances.

        • ObjectTypeNamerequired — (String)

          The name of the profile object type.

        • Descriptionrequired — (String)

          Description of the profile object type.

        • CreatedAt — (Date)

          The timestamp of when the domain was created.

        • LastUpdatedAt — (Date)

          The timestamp of when the domain was most recently edited.

        • Tags — (map<String>)

          The tags used to organize, track, or control access for this resource.

      • NextToken — (String)

        Identifies the next page of results to return.

Returns:

  • (AWS.Request)

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

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

Lists all of the template information for object types.

Service Reference:

Examples:

Calling the listProfileObjectTypeTemplates operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
customerprofiles.listProfileObjectTypeTemplates(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)

      The pagination token from the previous ListObjectTypeTemplates API call.

    • MaxResults — (Integer)

      The maximum number of objects returned per page.

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:

      • Items — (Array<map>)

        The list of ListProfileObjectType template instances.

        • TemplateId — (String)

          A unique identifier for the object template.

        • SourceName — (String)

          The name of the source of the object template.

        • SourceObject — (String)

          The source of the object template.

      • NextToken — (String)

        The pagination token from the previous ListObjectTypeTemplates API call.

Returns:

  • (AWS.Request)

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

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

Displays the tags associated with an Amazon Connect Customer Profiles resource. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
customerprofiles.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 ARN of the resource for which you want to view tags.

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 — (map<String>)

        The tags used to organize, track, or control access for this resource.

Returns:

  • (AWS.Request)

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

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

This API is in preview release for Amazon Connect and subject to change.

Runs an AWS Lambda job that does the following:

  1. All the profileKeys in the ProfileToBeMerged will be moved to the main profile.

  2. All the objects in the ProfileToBeMerged will be moved to the main profile.

  3. All the ProfileToBeMerged will be deleted at the end.

  4. All the profileKeys in the ProfileIdsToBeMerged will be moved to the main profile.

  5. Standard fields are merged as follows:

    1. Fields are always "union"-ed if there are no conflicts in standard fields or attributeKeys.

    2. When there are conflicting fields:

      1. If no SourceProfileIds entry is specified, the main Profile value is always taken.

      2. If a SourceProfileIds entry is specified, the specified profileId is always taken, even if it is a NULL value.

You can use MergeProfiles together with GetMatches, which returns potentially matching profiles, or use it with the results of another matching system. After profiles have been merged, they cannot be separated (unmerged).

Service Reference:

Examples:

Calling the mergeProfiles operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  MainProfileId: 'STRING_VALUE', /* required */
  ProfileIdsToBeMerged: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  FieldSourceProfileIds: {
    AccountNumber: 'STRING_VALUE',
    AdditionalInformation: 'STRING_VALUE',
    Address: 'STRING_VALUE',
    Attributes: {
      '<string1To255>': 'STRING_VALUE',
      /* '<string1To255>': ... */
    },
    BillingAddress: 'STRING_VALUE',
    BirthDate: 'STRING_VALUE',
    BusinessEmailAddress: 'STRING_VALUE',
    BusinessName: 'STRING_VALUE',
    BusinessPhoneNumber: 'STRING_VALUE',
    EmailAddress: 'STRING_VALUE',
    FirstName: 'STRING_VALUE',
    Gender: 'STRING_VALUE',
    HomePhoneNumber: 'STRING_VALUE',
    LastName: 'STRING_VALUE',
    MailingAddress: 'STRING_VALUE',
    MiddleName: 'STRING_VALUE',
    MobilePhoneNumber: 'STRING_VALUE',
    PartyType: 'STRING_VALUE',
    PersonalEmailAddress: 'STRING_VALUE',
    PhoneNumber: 'STRING_VALUE',
    ShippingAddress: 'STRING_VALUE'
  }
};
customerprofiles.mergeProfiles(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: {})
    • DomainName — (String)

      The unique name of the domain.

    • MainProfileId — (String)

      The identifier of the profile to be taken.

    • ProfileIdsToBeMerged — (Array<String>)

      The identifier of the profile to be merged into MainProfileId.

    • FieldSourceProfileIds — (map)

      The identifiers of the fields in the profile that has the information you want to apply to the merge. For example, say you want to merge EmailAddress from Profile1 into MainProfile. This would be the identifier of the EmailAddress field in Profile1.

      • AccountNumber — (String)

        A unique identifier for the account number field to be merged.

      • AdditionalInformation — (String)

        A unique identifier for the additional information field to be merged.

      • PartyType — (String)

        A unique identifier for the party type field to be merged.

      • BusinessName — (String)

        A unique identifier for the business name field to be merged.

      • FirstName — (String)

        A unique identifier for the first name field to be merged.

      • MiddleName — (String)

        A unique identifier for the middle name field to be merged.

      • LastName — (String)

        A unique identifier for the last name field to be merged.

      • BirthDate — (String)

        A unique identifier for the birthdate field to be merged.

      • Gender — (String)

        A unique identifier for the gender field to be merged.

      • PhoneNumber — (String)

        A unique identifier for the phone number field to be merged.

      • MobilePhoneNumber — (String)

        A unique identifier for the mobile phone number field to be merged.

      • HomePhoneNumber — (String)

        A unique identifier for the home phone number field to be merged.

      • BusinessPhoneNumber — (String)

        A unique identifier for the business phone number field to be merged.

      • EmailAddress — (String)

        A unique identifier for the email address field to be merged.

      • PersonalEmailAddress — (String)

        A unique identifier for the personal email address field to be merged.

      • BusinessEmailAddress — (String)

        A unique identifier for the party type field to be merged.

      • Address — (String)

        A unique identifier for the party type field to be merged.

      • ShippingAddress — (String)

        A unique identifier for the shipping address field to be merged.

      • MailingAddress — (String)

        A unique identifier for the mailing address field to be merged.

      • BillingAddress — (String)

        A unique identifier for the billing type field to be merged.

      • Attributes — (map<String>)

        A unique identifier for the attributes field to be merged.

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:

      • Message — (String)

        A message that indicates the merge request is complete.

Returns:

  • (AWS.Request)

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

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

Adds an integration between the service and a third-party service, which includes Amazon AppFlow and Amazon Connect.

An integration can belong to only one domain.

Service Reference:

Examples:

Calling the putIntegration operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  ObjectTypeName: 'STRING_VALUE', /* required */
  FlowDefinition: {
    FlowName: 'STRING_VALUE', /* required */
    KmsArn: 'STRING_VALUE', /* required */
    SourceFlowConfig: { /* required */
      ConnectorType: Salesforce | Marketo | Zendesk | Servicenow | S3, /* required */
      SourceConnectorProperties: { /* required */
        Marketo: {
          Object: 'STRING_VALUE' /* required */
        },
        S3: {
          BucketName: 'STRING_VALUE', /* required */
          BucketPrefix: 'STRING_VALUE'
        },
        Salesforce: {
          Object: 'STRING_VALUE', /* required */
          EnableDynamicFieldUpdate: true || false,
          IncludeDeletedRecords: true || false
        },
        ServiceNow: {
          Object: 'STRING_VALUE' /* required */
        },
        Zendesk: {
          Object: 'STRING_VALUE' /* required */
        }
      },
      ConnectorProfileName: 'STRING_VALUE',
      IncrementalPullConfig: {
        DatetimeTypeFieldName: 'STRING_VALUE'
      }
    },
    Tasks: [ /* required */
      {
        SourceFields: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        TaskType: Arithmetic | Filter | Map | Mask | Merge | Truncate | Validate, /* required */
        ConnectorOperator: {
          Marketo: PROJECTION | LESS_THAN | GREATER_THAN | BETWEEN | ADDITION | MULTIPLICATION | DIVISION | SUBTRACTION | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NON_NEGATIVE | VALIDATE_NUMERIC | NO_OP,
          S3: PROJECTION | LESS_THAN | GREATER_THAN | BETWEEN | LESS_THAN_OR_EQUAL_TO | GREATER_THAN_OR_EQUAL_TO | EQUAL_TO | NOT_EQUAL_TO | ADDITION | MULTIPLICATION | DIVISION | SUBTRACTION | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NON_NEGATIVE | VALIDATE_NUMERIC | NO_OP,
          Salesforce: PROJECTION | LESS_THAN | CONTAINS | GREATER_THAN | BETWEEN | LESS_THAN_OR_EQUAL_TO | GREATER_THAN_OR_EQUAL_TO | EQUAL_TO | NOT_EQUAL_TO | ADDITION | MULTIPLICATION | DIVISION | SUBTRACTION | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NON_NEGATIVE | VALIDATE_NUMERIC | NO_OP,
          ServiceNow: PROJECTION | CONTAINS | LESS_THAN | GREATER_THAN | BETWEEN | LESS_THAN_OR_EQUAL_TO | GREATER_THAN_OR_EQUAL_TO | EQUAL_TO | NOT_EQUAL_TO | ADDITION | MULTIPLICATION | DIVISION | SUBTRACTION | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NON_NEGATIVE | VALIDATE_NUMERIC | NO_OP,
          Zendesk: PROJECTION | GREATER_THAN | ADDITION | MULTIPLICATION | DIVISION | SUBTRACTION | MASK_ALL | MASK_FIRST_N | MASK_LAST_N | VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NON_NEGATIVE | VALIDATE_NUMERIC | NO_OP
        },
        DestinationField: 'STRING_VALUE',
        TaskProperties: {
          '<OperatorPropertiesKeys>': 'STRING_VALUE',
          /* '<OperatorPropertiesKeys>': ... */
        }
      },
      /* more items */
    ],
    TriggerConfig: { /* required */
      TriggerType: Scheduled | Event | OnDemand, /* required */
      TriggerProperties: {
        Scheduled: {
          ScheduleExpression: 'STRING_VALUE', /* required */
          DataPullMode: Incremental | Complete,
          FirstExecutionFrom: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
          ScheduleEndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
          ScheduleOffset: 'NUMBER_VALUE',
          ScheduleStartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
          Timezone: 'STRING_VALUE'
        }
      }
    },
    Description: 'STRING_VALUE'
  },
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  Uri: 'STRING_VALUE'
};
customerprofiles.putIntegration(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: {})
    • DomainName — (String)

      The unique name of the domain.

    • Uri — (String)

      The URI of the S3 bucket or any other type of data source.

    • ObjectTypeName — (String)

      The name of the profile object type.

    • Tags — (map<String>)

      The tags used to organize, track, or control access for this resource.

    • FlowDefinition — (map)

      The configuration that controls how Customer Profiles retrieves data from the source.

      • Description — (String)

        A description of the flow you want to create.

      • FlowNamerequired — (String)

        The specified name of the flow. Use underscores (_) or hyphens (-) only. Spaces are not allowed.

      • KmsArnrequired — (String)

        The Amazon Resource Name of the AWS Key Management Service (KMS) key you provide for encryption.

      • SourceFlowConfigrequired — (map)

        The configuration that controls how Customer Profiles retrieves data from the source.

        • ConnectorProfileName — (String)

          The name of the AppFlow connector profile. This name must be unique for each connector profile in the AWS account.

        • ConnectorTyperequired — (String)

          The type of connector, such as Salesforce, Marketo, and so on.

          Possible values include:
          • "Salesforce"
          • "Marketo"
          • "Zendesk"
          • "Servicenow"
          • "S3"
        • IncrementalPullConfig — (map)

          Defines the configuration for a scheduled incremental data pull. If a valid configuration is provided, the fields specified in the configuration are used when querying for the incremental data pull.

          • DatetimeTypeFieldName — (String)

            A field that specifies the date time or timestamp field as the criteria to use when importing incremental records from the source.

        • SourceConnectorPropertiesrequired — (map)

          Specifies the information that is required to query a particular source connector.

          • Marketo — (map)

            The properties that are applied when Marketo is being used as a source.

            • Objectrequired — (String)

              The object specified in the Marketo flow source.

          • S3 — (map)

            The properties that are applied when Amazon S3 is being used as the flow source.

            • BucketNamerequired — (String)

              The Amazon S3 bucket name where the source files are stored.

            • BucketPrefix — (String)

              The object key for the Amazon S3 bucket in which the source files are stored.

          • Salesforce — (map)

            The properties that are applied when Salesforce is being used as a source.

            • Objectrequired — (String)

              The object specified in the Salesforce flow source.

            • EnableDynamicFieldUpdate — (Boolean)

              The flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects while running a flow.

            • IncludeDeletedRecords — (Boolean)

              Indicates whether Amazon AppFlow includes deleted files in the flow run.

          • ServiceNow — (map)

            The properties that are applied when ServiceNow is being used as a source.

            • Objectrequired — (String)

              The object specified in the ServiceNow flow source.

          • Zendesk — (map)

            The properties that are applied when using Zendesk as a flow source.

            • Objectrequired — (String)

              The object specified in the Zendesk flow source.

      • Tasksrequired — (Array<map>)

        A list of tasks that Customer Profiles performs while transferring the data in the flow run.

        • ConnectorOperator — (map)

          The operation to be performed on the provided source fields.

          • Marketo — (String)

            The operation to be performed on the provided Marketo source fields.

            Possible values include:
            • "PROJECTION"
            • "LESS_THAN"
            • "GREATER_THAN"
            • "BETWEEN"
            • "ADDITION"
            • "MULTIPLICATION"
            • "DIVISION"
            • "SUBTRACTION"
            • "MASK_ALL"
            • "MASK_FIRST_N"
            • "MASK_LAST_N"
            • "VALIDATE_NON_NULL"
            • "VALIDATE_NON_ZERO"
            • "VALIDATE_NON_NEGATIVE"
            • "VALIDATE_NUMERIC"
            • "NO_OP"
          • S3 — (String)

            The operation to be performed on the provided Amazon S3 source fields.

            Possible values include:
            • "PROJECTION"
            • "LESS_THAN"
            • "GREATER_THAN"
            • "BETWEEN"
            • "LESS_THAN_OR_EQUAL_TO"
            • "GREATER_THAN_OR_EQUAL_TO"
            • "EQUAL_TO"
            • "NOT_EQUAL_TO"
            • "ADDITION"
            • "MULTIPLICATION"
            • "DIVISION"
            • "SUBTRACTION"
            • "MASK_ALL"
            • "MASK_FIRST_N"
            • "MASK_LAST_N"
            • "VALIDATE_NON_NULL"
            • "VALIDATE_NON_ZERO"
            • "VALIDATE_NON_NEGATIVE"
            • "VALIDATE_NUMERIC"
            • "NO_OP"
          • Salesforce — (String)

            The operation to be performed on the provided Salesforce source fields.

            Possible values include:
            • "PROJECTION"
            • "LESS_THAN"
            • "CONTAINS"
            • "GREATER_THAN"
            • "BETWEEN"
            • "LESS_THAN_OR_EQUAL_TO"
            • "GREATER_THAN_OR_EQUAL_TO"
            • "EQUAL_TO"
            • "NOT_EQUAL_TO"
            • "ADDITION"
            • "MULTIPLICATION"
            • "DIVISION"
            • "SUBTRACTION"
            • "MASK_ALL"
            • "MASK_FIRST_N"
            • "MASK_LAST_N"
            • "VALIDATE_NON_NULL"
            • "VALIDATE_NON_ZERO"
            • "VALIDATE_NON_NEGATIVE"
            • "VALIDATE_NUMERIC"
            • "NO_OP"
          • ServiceNow — (String)

            The operation to be performed on the provided ServiceNow source fields.

            Possible values include:
            • "PROJECTION"
            • "CONTAINS"
            • "LESS_THAN"
            • "GREATER_THAN"
            • "BETWEEN"
            • "LESS_THAN_OR_EQUAL_TO"
            • "GREATER_THAN_OR_EQUAL_TO"
            • "EQUAL_TO"
            • "NOT_EQUAL_TO"
            • "ADDITION"
            • "MULTIPLICATION"
            • "DIVISION"
            • "SUBTRACTION"
            • "MASK_ALL"
            • "MASK_FIRST_N"
            • "MASK_LAST_N"
            • "VALIDATE_NON_NULL"
            • "VALIDATE_NON_ZERO"
            • "VALIDATE_NON_NEGATIVE"
            • "VALIDATE_NUMERIC"
            • "NO_OP"
          • Zendesk — (String)

            The operation to be performed on the provided Zendesk source fields.

            Possible values include:
            • "PROJECTION"
            • "GREATER_THAN"
            • "ADDITION"
            • "MULTIPLICATION"
            • "DIVISION"
            • "SUBTRACTION"
            • "MASK_ALL"
            • "MASK_FIRST_N"
            • "MASK_LAST_N"
            • "VALIDATE_NON_NULL"
            • "VALIDATE_NON_ZERO"
            • "VALIDATE_NON_NEGATIVE"
            • "VALIDATE_NUMERIC"
            • "NO_OP"
        • DestinationField — (String)

          A field in a destination connector, or a field value against which Amazon AppFlow validates a source field.

        • SourceFieldsrequired — (Array<String>)

          The source fields to which a particular task is applied.

        • TaskProperties — (map<String>)

          A map used to store task-related information. The service looks for particular information based on the TaskType.

        • TaskTyperequired — (String)

          Specifies the particular task implementation that Amazon AppFlow performs.

          Possible values include:
          • "Arithmetic"
          • "Filter"
          • "Map"
          • "Mask"
          • "Merge"
          • "Truncate"
          • "Validate"
      • TriggerConfigrequired — (map)

        The trigger settings that determine how and when the flow runs.

        • TriggerTyperequired — (String)

          Specifies the type of flow trigger. It can be OnDemand, Scheduled, or Event.

          Possible values include:
          • "Scheduled"
          • "Event"
          • "OnDemand"
        • TriggerProperties — (map)

          Specifies the configuration details of a schedule-triggered flow that you define. Currently, these settings only apply to the Scheduled trigger type.

          • Scheduled — (map)

            Specifies the configuration details of a schedule-triggered flow that you define.

            • ScheduleExpressionrequired — (String)

              The scheduling expression that determines the rate at which the schedule will run, for example rate (5 minutes).

            • DataPullMode — (String)

              Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.

              Possible values include:
              • "Incremental"
              • "Complete"
            • ScheduleStartTime — (Date)

              Specifies the scheduled start time for a scheduled-trigger flow.

            • ScheduleEndTime — (Date)

              Specifies the scheduled end time for a scheduled-trigger flow.

            • Timezone — (String)

              Specifies the time zone used when referring to the date and time of a scheduled-triggered flow, such as America/New_York.

            • ScheduleOffset — (Integer)

              Specifies the optional offset that is added to the time interval for a schedule-triggered flow.

            • FirstExecutionFrom — (Date)

              Specifies the date range for the records to import from the connector in the first flow run.

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:

      • DomainName — (String)

        The unique name of the domain.

      • Uri — (String)

        The URI of the S3 bucket or any other type of data source.

      • ObjectTypeName — (String)

        The name of the profile object type.

      • CreatedAt — (Date)

        The timestamp of when the domain was created.

      • LastUpdatedAt — (Date)

        The timestamp of when the domain was most recently edited.

      • Tags — (map<String>)

        The tags used to organize, track, or control access for this resource.

Returns:

  • (AWS.Request)

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

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

Adds additional objects to customer profiles of a given ObjectType.

When adding a specific profile object, like a Contact Trace Record (CTR), an inferred profile can get created if it is not mapped to an existing profile. The resulting profile will only have a phone number populated in the standard ProfileObject. Any additional CTRs with the same phone number will be mapped to the same inferred profile.

When a ProfileObject is created and if a ProfileObjectType already exists for the ProfileObject, it will provide data to a standard profile depending on the ProfileObjectType definition.

PutProfileObject needs an ObjectType, which can be created using PutProfileObjectType.

Service Reference:

Examples:

Calling the putProfileObject operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  Object: 'STRING_VALUE', /* required */
  ObjectTypeName: 'STRING_VALUE' /* required */
};
customerprofiles.putProfileObject(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: {})
    • ObjectTypeName — (String)

      The name of the profile object type.

    • Object — (String)

      A string that is serialized from a JSON object.

    • DomainName — (String)

      The unique name of the domain.

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:

      • ProfileObjectUniqueKey — (String)

        The unique identifier of the profile object generated by the service.

Returns:

  • (AWS.Request)

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

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

Defines a ProfileObjectType.

Service Reference:

Examples:

Calling the putProfileObjectType operation

var params = {
  Description: 'STRING_VALUE', /* required */
  DomainName: 'STRING_VALUE', /* required */
  ObjectTypeName: 'STRING_VALUE', /* required */
  AllowProfileCreation: true || false,
  EncryptionKey: 'STRING_VALUE',
  ExpirationDays: 'NUMBER_VALUE',
  Fields: {
    '<name>': {
      ContentType: STRING | NUMBER | PHONE_NUMBER | EMAIL_ADDRESS | NAME,
      Source: 'STRING_VALUE',
      Target: 'STRING_VALUE'
    },
    /* '<name>': ... */
  },
  Keys: {
    '<name>': [
      {
        FieldNames: [
          'STRING_VALUE',
          /* more items */
        ],
        StandardIdentifiers: [
          PROFILE | UNIQUE | SECONDARY | LOOKUP_ONLY | NEW_ONLY,
          /* more items */
        ]
      },
      /* more items */
    ],
    /* '<name>': ... */
  },
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  TemplateId: 'STRING_VALUE'
};
customerprofiles.putProfileObjectType(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: {})
    • DomainName — (String)

      The unique name of the domain.

    • ObjectTypeName — (String)

      The name of the profile object type.

    • Description — (String)

      Description of the profile object type.

    • TemplateId — (String)

      A unique identifier for the object template.

    • ExpirationDays — (Integer)

      The number of days until the data in the object expires.

    • EncryptionKey — (String)

      The customer-provided key to encrypt the profile object that will be created in this profile object type.

    • AllowProfileCreation — (Boolean)

      Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. The default is FALSE. If the AllowProfileCreation flag is set to FALSE, then the service tries to fetch a standard profile and associate this object with the profile. If it is set to TRUE, and if no match is found, then the service creates a new standard profile.

    • Fields — (map<map>)

      A map of the name and ObjectType field.

      • Source — (String)

        A field of a ProfileObject. For example: source.FirstName, where “source” is a ProfileObjectType of a Zendesk user and “FirstName” is a field in that ObjectType.

      • Target — (String)

        The location of the data in the standard ProfileObject model. For example: _profile.Address.PostalCode.

      • ContentType — (String)

        The content type of the field. Used for determining equality when searching.

        Possible values include:
        • "STRING"
        • "NUMBER"
        • "PHONE_NUMBER"
        • "EMAIL_ADDRESS"
        • "NAME"
    • Keys — (map<Array<map>>)

      A list of unique keys that can be used to map data to the profile.

      • StandardIdentifiers — (Array<String>)

        The types of keys that a ProfileObject can have. Each ProfileObject can have only 1 UNIQUE key but multiple PROFILE keys. PROFILE means that this key can be used to tie an object to a PROFILE. UNIQUE means that it can be used to uniquely identify an object. If a key a is marked as SECONDARY, it will be used to search for profiles after all other PROFILE keys have been searched. A LOOKUP_ONLY key is only used to match a profile but is not persisted to be used for searching of the profile. A NEW_ONLY key is only used if the profile does not already exist before the object is ingested, otherwise it is only used for matching objects to profiles.

      • FieldNames — (Array<String>)

        The reference for the key name of the fields map.

    • Tags — (map<String>)

      The tags used to organize, track, or control access for this resource.

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:

      • ObjectTypeName — (String)

        The name of the profile object type.

      • Description — (String)

        Description of the profile object type.

      • TemplateId — (String)

        A unique identifier for the object template.

      • ExpirationDays — (Integer)

        The number of days until the data in the object expires.

      • EncryptionKey — (String)

        The customer-provided key to encrypt the profile object that will be created in this profile object type.

      • AllowProfileCreation — (Boolean)

        Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. The default is FALSE. If the AllowProfileCreation flag is set to FALSE, then the service tries to fetch a standard profile and associate this object with the profile. If it is set to TRUE, and if no match is found, then the service creates a new standard profile.

      • Fields — (map<map>)

        A map of the name and ObjectType field.

        • Source — (String)

          A field of a ProfileObject. For example: source.FirstName, where “source” is a ProfileObjectType of a Zendesk user and “FirstName” is a field in that ObjectType.

        • Target — (String)

          The location of the data in the standard ProfileObject model. For example: _profile.Address.PostalCode.

        • ContentType — (String)

          The content type of the field. Used for determining equality when searching.

          Possible values include:
          • "STRING"
          • "NUMBER"
          • "PHONE_NUMBER"
          • "EMAIL_ADDRESS"
          • "NAME"
      • Keys — (map<Array<map>>)

        A list of unique keys that can be used to map data to the profile.

        • StandardIdentifiers — (Array<String>)

          The types of keys that a ProfileObject can have. Each ProfileObject can have only 1 UNIQUE key but multiple PROFILE keys. PROFILE means that this key can be used to tie an object to a PROFILE. UNIQUE means that it can be used to uniquely identify an object. If a key a is marked as SECONDARY, it will be used to search for profiles after all other PROFILE keys have been searched. A LOOKUP_ONLY key is only used to match a profile but is not persisted to be used for searching of the profile. A NEW_ONLY key is only used if the profile does not already exist before the object is ingested, otherwise it is only used for matching objects to profiles.

        • FieldNames — (Array<String>)

          The reference for the key name of the fields map.

      • CreatedAt — (Date)

        The timestamp of when the domain was created.

      • LastUpdatedAt — (Date)

        The timestamp of when the domain was most recently edited.

      • Tags — (map<String>)

        The tags used to organize, track, or control access for this resource.

Returns:

  • (AWS.Request)

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

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

Searches for profiles within a specific domain name using name, phone number, email address, account number, or a custom defined index.

Service Reference:

Examples:

Calling the searchProfiles operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  KeyName: 'STRING_VALUE', /* required */
  Values: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
customerprofiles.searchProfiles(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)

      The pagination token from the previous SearchProfiles API call.

    • MaxResults — (Integer)

      The maximum number of objects returned per page.

    • DomainName — (String)

      The unique name of the domain.

    • KeyName — (String)

      A searchable identifier of a customer profile. The predefined keys you can use to search include: account, profileId, fullName, phone, email, ctrContactId, marketoLeadId, salesforceAccountId, salesforceContactId, zendeskUserId, zendeskExternalId, serviceNowSystemId.

    • Values — (Array<String>)

      A list of key values.

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:

      • Items — (Array<map>)

        The list of SearchProfiles instances.

        • ProfileId — (String)

          The unique identifier of a customer profile.

        • AccountNumber — (String)

          A unique account number that you have given to the customer.

        • AdditionalInformation — (String)

          Any additional information relevant to the customer’s profile.

        • PartyType — (String)

          The type of profile used to describe the customer.

          Possible values include:
          • "INDIVIDUAL"
          • "BUSINESS"
          • "OTHER"
        • BusinessName — (String)

          The name of the customer’s business.

        • FirstName — (String)

          The customer’s first name.

        • MiddleName — (String)

          The customer’s middle name.

        • LastName — (String)

          The customer’s last name.

        • BirthDate — (String)

          The customer’s birth date.

        • Gender — (String)

          The gender with which the customer identifies.

          Possible values include:
          • "MALE"
          • "FEMALE"
          • "UNSPECIFIED"
        • PhoneNumber — (String)

          The customer's phone number, which has not been specified as a mobile, home, or business number.

        • MobilePhoneNumber — (String)

          The customer’s mobile phone number.

        • HomePhoneNumber — (String)

          The customer’s home phone number.

        • BusinessPhoneNumber — (String)

          The customer’s home phone number.

        • EmailAddress — (String)

          The customer’s email address, which has not been specified as a personal or business address.

        • PersonalEmailAddress — (String)

          The customer’s personal email address.

        • BusinessEmailAddress — (String)

          The customer’s business email address.

        • Address — (map)

          A generic address associated with the customer that is not mailing, shipping, or billing.

          • Address1 — (String)

            The first line of a customer address.

          • Address2 — (String)

            The second line of a customer address.

          • Address3 — (String)

            The third line of a customer address.

          • Address4 — (String)

            The fourth line of a customer address.

          • City — (String)

            The city in which a customer lives.

          • County — (String)

            The county in which a customer lives.

          • State — (String)

            The state in which a customer lives.

          • Province — (String)

            The province in which a customer lives.

          • Country — (String)

            The country in which a customer lives.

          • PostalCode — (String)

            The postal code of a customer address.

        • ShippingAddress — (map)

          The customer’s shipping address.

          • Address1 — (String)

            The first line of a customer address.

          • Address2 — (String)

            The second line of a customer address.

          • Address3 — (String)

            The third line of a customer address.

          • Address4 — (String)

            The fourth line of a customer address.

          • City — (String)

            The city in which a customer lives.

          • County — (String)

            The county in which a customer lives.

          • State — (String)

            The state in which a customer lives.

          • Province — (String)

            The province in which a customer lives.

          • Country — (String)

            The country in which a customer lives.

          • PostalCode — (String)

            The postal code of a customer address.

        • MailingAddress — (map)

          The customer’s mailing address.

          • Address1 — (String)

            The first line of a customer address.

          • Address2 — (String)

            The second line of a customer address.

          • Address3 — (String)

            The third line of a customer address.

          • Address4 — (String)

            The fourth line of a customer address.

          • City — (String)

            The city in which a customer lives.

          • County — (String)

            The county in which a customer lives.

          • State — (String)

            The state in which a customer lives.

          • Province — (String)

            The province in which a customer lives.

          • Country — (String)

            The country in which a customer lives.

          • PostalCode — (String)

            The postal code of a customer address.

        • BillingAddress — (map)

          The customer’s billing address.

          • Address1 — (String)

            The first line of a customer address.

          • Address2 — (String)

            The second line of a customer address.

          • Address3 — (String)

            The third line of a customer address.

          • Address4 — (String)

            The fourth line of a customer address.

          • City — (String)

            The city in which a customer lives.

          • County — (String)

            The county in which a customer lives.

          • State — (String)

            The state in which a customer lives.

          • Province — (String)

            The province in which a customer lives.

          • Country — (String)

            The country in which a customer lives.

          • PostalCode — (String)

            The postal code of a customer address.

        • Attributes — (map<String>)

          A key value pair of attributes of a customer profile.

      • NextToken — (String)

        The pagination token from the previous SearchProfiles API call.

Returns:

  • (AWS.Request)

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

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

Assigns one or more tags (key-value pairs) to the specified Amazon Connect Customer Profiles resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged.

Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.

You can use the TagResource action with a resource that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.

You can associate as many as 50 tags with a resource.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
customerprofiles.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 ARN of the resource that you're adding tags to.

    • tags — (map<String>)

      The tags used to organize, track, or control access for this resource.

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

Removes one or more tags from the specified Amazon Connect Customer Profiles resource. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
customerprofiles.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 ARN of the resource from which you are removing tags.

    • tagKeys — (Array<String>)

      The list of tag keys to remove from the resource.

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.

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

Updates the properties of a domain, including creating or selecting a dead letter queue or an encryption key.

After a domain is created, the name can’t be changed.

Service Reference:

Examples:

Calling the updateDomain operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  DeadLetterQueueUrl: 'STRING_VALUE',
  DefaultEncryptionKey: 'STRING_VALUE',
  DefaultExpirationDays: 'NUMBER_VALUE',
  Matching: {
    Enabled: true || false /* required */
  },
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
customerprofiles.updateDomain(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: {})
    • DomainName — (String)

      The unique name of the domain.

    • DefaultExpirationDays — (Integer)

      The default number of days until the data within the domain expires.

    • DefaultEncryptionKey — (String)

      The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage. If specified as an empty string, it will clear any existing value.

    • DeadLetterQueueUrl — (String)

      The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications. If specified as an empty string, it will clear any existing value. You must set up a policy on the DeadLetterQueue for the SendMessage operation to enable Amazon Connect Customer Profiles to send messages to the DeadLetterQueue.

    • Matching — (map)

      The process of matching duplicate profiles. This process runs every Saturday at 12AM.

      • Enabledrequired — (Boolean)

        The flag that enables the matching process of duplicate profiles.

    • Tags — (map<String>)

      The tags used to organize, track, or control access for this resource.

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:

      • DomainName — (String)

        The unique name of the domain.

      • DefaultExpirationDays — (Integer)

        The default number of days until the data within the domain expires.

      • DefaultEncryptionKey — (String)

        The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage.

      • DeadLetterQueueUrl — (String)

        The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.

      • Matching — (map)

        The process of matching duplicate profiles. This process runs every Saturday at 12AM.

        • Enabled — (Boolean)

          The flag that enables the matching process of duplicate profiles.

      • CreatedAt — (Date)

        The timestamp of when the domain was created.

      • LastUpdatedAt — (Date)

        The timestamp of when the domain was most recently edited.

      • Tags — (map<String>)

        The tags used to organize, track, or control access for this resource.

Returns:

  • (AWS.Request)

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

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

Updates the properties of a profile. The ProfileId is required for updating a customer profile.

When calling the UpdateProfile API, specifying an empty string value means that any existing value will be removed. Not specifying a string value means that any value already there will be kept.

Service Reference:

Examples:

Calling the updateProfile operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  ProfileId: 'STRING_VALUE', /* required */
  AccountNumber: 'STRING_VALUE',
  AdditionalInformation: 'STRING_VALUE',
  Address: {
    Address1: 'STRING_VALUE',
    Address2: 'STRING_VALUE',
    Address3: 'STRING_VALUE',
    Address4: 'STRING_VALUE',
    City: 'STRING_VALUE',
    Country: 'STRING_VALUE',
    County: 'STRING_VALUE',
    PostalCode: 'STRING_VALUE',
    Province: 'STRING_VALUE',
    State: 'STRING_VALUE'
  },
  Attributes: {
    '<string1To255>': 'STRING_VALUE',
    /* '<string1To255>': ... */
  },
  BillingAddress: {
    Address1: 'STRING_VALUE',
    Address2: 'STRING_VALUE',
    Address3: 'STRING_VALUE',
    Address4: 'STRING_VALUE',
    City: 'STRING_VALUE',
    Country: 'STRING_VALUE',
    County: 'STRING_VALUE',
    PostalCode: 'STRING_VALUE',
    Province: 'STRING_VALUE',
    State: 'STRING_VALUE'
  },
  BirthDate: 'STRING_VALUE',
  BusinessEmailAddress: 'STRING_VALUE',
  BusinessName: 'STRING_VALUE',
  BusinessPhoneNumber: 'STRING_VALUE',
  EmailAddress: 'STRING_VALUE',
  FirstName: 'STRING_VALUE',
  Gender: MALE | FEMALE | UNSPECIFIED,
  HomePhoneNumber: 'STRING_VALUE',
  LastName: 'STRING_VALUE',
  MailingAddress: {
    Address1: 'STRING_VALUE',
    Address2: 'STRING_VALUE',
    Address3: 'STRING_VALUE',
    Address4: 'STRING_VALUE',
    City: 'STRING_VALUE',
    Country: 'STRING_VALUE',
    County: 'STRING_VALUE',
    PostalCode: 'STRING_VALUE',
    Province: 'STRING_VALUE',
    State: 'STRING_VALUE'
  },
  MiddleName: 'STRING_VALUE',
  MobilePhoneNumber: 'STRING_VALUE',
  PartyType: INDIVIDUAL | BUSINESS | OTHER,
  PersonalEmailAddress: 'STRING_VALUE',
  PhoneNumber: 'STRING_VALUE',
  ShippingAddress: {
    Address1: 'STRING_VALUE',
    Address2: 'STRING_VALUE',
    Address3: 'STRING_VALUE',
    Address4: 'STRING_VALUE',
    City: 'STRING_VALUE',
    Country: 'STRING_VALUE',
    County: 'STRING_VALUE',
    PostalCode: 'STRING_VALUE',
    Province: 'STRING_VALUE',
    State: 'STRING_VALUE'
  }
};
customerprofiles.updateProfile(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: {})
    • DomainName — (String)

      The unique name of the domain.

    • ProfileId — (String)

      The unique identifier of a customer profile.

    • AdditionalInformation — (String)

      Any additional information relevant to the customer’s profile.

    • AccountNumber — (String)

      A unique account number that you have given to the customer.

    • PartyType — (String)

      The type of profile used to describe the customer.

      Possible values include:
      • "INDIVIDUAL"
      • "BUSINESS"
      • "OTHER"
    • BusinessName — (String)

      The name of the customer’s business.

    • FirstName — (String)

      The customer’s first name.

    • MiddleName — (String)

      The customer’s middle name.

    • LastName — (String)

      The customer’s last name.

    • BirthDate — (String)

      The customer’s birth date.

    • Gender — (String)

      The gender with which the customer identifies.

      Possible values include:
      • "MALE"
      • "FEMALE"
      • "UNSPECIFIED"
    • PhoneNumber — (String)

      The customer’s phone number, which has not been specified as a mobile, home, or business number.

    • MobilePhoneNumber — (String)

      The customer’s mobile phone number.

    • HomePhoneNumber — (String)

      The customer’s home phone number.

    • BusinessPhoneNumber — (String)

      The customer’s business phone number.

    • EmailAddress — (String)

      The customer’s email address, which has not been specified as a personal or business address.

    • PersonalEmailAddress — (String)

      The customer’s personal email address.

    • BusinessEmailAddress — (String)

      The customer’s business email address.

    • Address — (map)

      A generic address associated with the customer that is not mailing, shipping, or billing.

      • Address1 — (String)

        The first line of a customer address.

      • Address2 — (String)

        The second line of a customer address.

      • Address3 — (String)

        The third line of a customer address.

      • Address4 — (String)

        The fourth line of a customer address.

      • City — (String)

        The city in which a customer lives.

      • County — (String)

        The county in which a customer lives.

      • State — (String)

        The state in which a customer lives.

      • Province — (String)

        The province in which a customer lives.

      • Country — (String)

        The country in which a customer lives.

      • PostalCode — (String)

        The postal code of a customer address.

    • ShippingAddress — (map)

      The customer’s shipping address.

      • Address1 — (String)

        The first line of a customer address.

      • Address2 — (String)

        The second line of a customer address.

      • Address3 — (String)

        The third line of a customer address.

      • Address4 — (String)

        The fourth line of a customer address.

      • City — (String)

        The city in which a customer lives.

      • County — (String)

        The county in which a customer lives.

      • State — (String)

        The state in which a customer lives.

      • Province — (String)

        The province in which a customer lives.

      • Country — (String)

        The country in which a customer lives.

      • PostalCode — (String)

        The postal code of a customer address.

    • MailingAddress — (map)

      The customer’s mailing address.

      • Address1 — (String)

        The first line of a customer address.

      • Address2 — (String)

        The second line of a customer address.

      • Address3 — (String)

        The third line of a customer address.

      • Address4 — (String)

        The fourth line of a customer address.

      • City — (String)

        The city in which a customer lives.

      • County — (String)

        The county in which a customer lives.

      • State — (String)

        The state in which a customer lives.

      • Province — (String)

        The province in which a customer lives.

      • Country — (String)

        The country in which a customer lives.

      • PostalCode — (String)

        The postal code of a customer address.

    • BillingAddress — (map)

      The customer’s billing address.

      • Address1 — (String)

        The first line of a customer address.

      • Address2 — (String)

        The second line of a customer address.

      • Address3 — (String)

        The third line of a customer address.

      • Address4 — (String)

        The fourth line of a customer address.

      • City — (String)

        The city in which a customer lives.

      • County — (String)

        The county in which a customer lives.

      • State — (String)

        The state in which a customer lives.

      • Province — (String)

        The province in which a customer lives.

      • Country — (String)

        The country in which a customer lives.

      • PostalCode — (String)

        The postal code of a customer address.

    • Attributes — (map<String>)

      A key value pair of attributes of a customer profile.

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:

      • ProfileId — (String)

        The unique identifier of a customer profile.

Returns:

  • (AWS.Request)

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