We announced the upcoming end-of-support for AWS SDK for JavaScript v2.
We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

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

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 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'.

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

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 Record 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. The predefined keys you can use include: account, profileId, assetId, caseId, orderId, fullName, phone, email, ctrContactId, marketoLeadId, salesforceAccountId, salesforceContactId, salesforceAssetId, zendeskUserId, zendeskExternalId, zendeskTicketId, serviceNowSystemId, serviceNowIncidentId, segmentUserId, shopifyCustomerId, _shopifyOrderId.

    • 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.

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

Creates a new calculated attribute definition. After creation, new object data ingested into Customer Profiles will be included in the calculated attribute, which can be retrieved for a profile using the GetCalculatedAttributeForProfile API. Defining a calculated attribute makes it available for all profiles within a domain. Each calculated attribute can only reference one ObjectType and at most, two fields from that ObjectType.

Examples:

Calling the createCalculatedAttributeDefinition operation

var params = {
  AttributeDetails: { /* required */
    Attributes: [ /* required */
      {
        Name: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    Expression: 'STRING_VALUE' /* required */
  },
  CalculatedAttributeName: 'STRING_VALUE', /* required */
  DomainName: 'STRING_VALUE', /* required */
  Statistic: FIRST_OCCURRENCE | LAST_OCCURRENCE | COUNT | SUM | MINIMUM | MAXIMUM | AVERAGE | MAX_OCCURRENCE, /* required */
  Conditions: {
    ObjectCount: 'NUMBER_VALUE',
    Range: {
      Unit: DAYS, /* required */
      Value: 'NUMBER_VALUE' /* required */
    },
    Threshold: {
      Operator: EQUAL_TO | GREATER_THAN | LESS_THAN | NOT_EQUAL_TO, /* required */
      Value: 'STRING_VALUE' /* required */
    }
  },
  Description: 'STRING_VALUE',
  DisplayName: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
customerprofiles.createCalculatedAttributeDefinition(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.

    • CalculatedAttributeName — (String)

      The unique name of the calculated attribute.

    • DisplayName — (String)

      The display name of the calculated attribute.

    • Description — (String)

      The description of the calculated attribute.

    • AttributeDetails — (map)

      Mathematical expression and a list of attribute items specified in that expression.

      • Attributesrequired — (Array<map>)

        A list of attribute items specified in the mathematical expression.

        • Namerequired — (String)

          The name of an attribute defined in a profile object type.

      • Expressionrequired — (String)

        Mathematical expression that is performed on attribute items provided in the attribute list. Each element in the expression should follow the structure of \"{ObjectTypeName.AttributeName}\".

    • Conditions — (map)

      The conditions including range, object count, and threshold for the calculated attribute.

      • Range — (map)

        The relative time period over which data is included in the aggregation.

        • Valuerequired — (Integer)

          The amount of time of the specified unit.

        • Unitrequired — (String)

          The unit of time.

          Possible values include:
          • "DAYS"
      • ObjectCount — (Integer)

        The number of profile objects used for the calculated attribute.

      • Threshold — (map)

        The threshold for the calculated attribute.

        • Valuerequired — (String)

          The value of the threshold.

        • Operatorrequired — (String)

          The operator of the threshold.

          Possible values include:
          • "EQUAL_TO"
          • "GREATER_THAN"
          • "LESS_THAN"
          • "NOT_EQUAL_TO"
    • Statistic — (String)

      The aggregation operation to perform for the calculated attribute.

      Possible values include:
      • "FIRST_OCCURRENCE"
      • "LAST_OCCURRENCE"
      • "COUNT"
      • "SUM"
      • "MINIMUM"
      • "MAXIMUM"
      • "AVERAGE"
      • "MAX_OCCURRENCE"
    • 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:

      • CalculatedAttributeName — (String)

        The unique name of the calculated attribute.

      • DisplayName — (String)

        The display name of the calculated attribute.

      • Description — (String)

        The description of the calculated attribute.

      • AttributeDetails — (map)

        Mathematical expression and a list of attribute items specified in that expression.

        • Attributesrequired — (Array<map>)

          A list of attribute items specified in the mathematical expression.

          • Namerequired — (String)

            The name of an attribute defined in a profile object type.

        • Expressionrequired — (String)

          Mathematical expression that is performed on attribute items provided in the attribute list. Each element in the expression should follow the structure of \"{ObjectTypeName.AttributeName}\".

      • Conditions — (map)

        The conditions including range, object count, and threshold for the calculated attribute.

        • Range — (map)

          The relative time period over which data is included in the aggregation.

          • Valuerequired — (Integer)

            The amount of time of the specified unit.

          • Unitrequired — (String)

            The unit of time.

            Possible values include:
            • "DAYS"
        • ObjectCount — (Integer)

          The number of profile objects used for the calculated attribute.

        • Threshold — (map)

          The threshold for the calculated attribute.

          • Valuerequired — (String)

            The value of the threshold.

          • Operatorrequired — (String)

            The operator of the threshold.

            Possible values include:
            • "EQUAL_TO"
            • "GREATER_THAN"
            • "LESS_THAN"
            • "NOT_EQUAL_TO"
      • Statistic — (String)

        The aggregation operation to perform for the calculated attribute.

        Possible values include:
        • "FIRST_OCCURRENCE"
        • "LAST_OCCURRENCE"
        • "COUNT"
        • "SUM"
        • "MINIMUM"
        • "MAXIMUM"
        • "AVERAGE"
        • "MAX_OCCURRENCE"
      • CreatedAt — (Date)

        The timestamp of when the calculated attribute definition was created.

      • LastUpdatedAt — (Date)

        The timestamp of when the calculated attribute definition 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.

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.

Use this API or UpdateDomain to enable identity resolution: set Matching to true.

To prevent cross-service impersonation when you call this API, see Cross-service confused deputy prevention for sample policies that you should apply.

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 */
    AutoMerging: {
      Enabled: true || false, /* required */
      ConflictResolution: {
        ConflictResolvingModel: RECENCY | SOURCE, /* required */
        SourceName: 'STRING_VALUE'
      },
      Consolidation: {
        MatchingAttributesList: [ /* required */
          [
            'STRING_VALUE',
            /* more items */
          ],
          /* more items */
        ]
      },
      MinAllowedConfidenceScoreForMerging: 'NUMBER_VALUE'
    },
    ExportingConfig: {
      S3Exporting: {
        S3BucketName: 'STRING_VALUE', /* required */
        S3KeyName: 'STRING_VALUE'
      }
    },
    JobSchedule: {
      DayOfTheWeek: SUNDAY | MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY, /* required */
      Time: 'STRING_VALUE' /* required */
    }
  },
  RuleBasedMatching: {
    Enabled: true || false, /* required */
    AttributeTypesSelector: {
      AttributeMatchingModel: ONE_TO_ONE | MANY_TO_MANY, /* required */
      Address: [
        'STRING_VALUE',
        /* more items */
      ],
      EmailAddress: [
        'STRING_VALUE',
        /* more items */
      ],
      PhoneNumber: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    ConflictResolution: {
      ConflictResolvingModel: RECENCY | SOURCE, /* required */
      SourceName: 'STRING_VALUE'
    },
    ExportingConfig: {
      S3Exporting: {
        S3BucketName: 'STRING_VALUE', /* required */
        S3KeyName: 'STRING_VALUE'
      }
    },
    MatchingRules: [
      {
        Rule: [ /* required */
          'STRING_VALUE',
          /* more items */
        ]
      },
      /* more items */
    ],
    MaxAllowedRuleLevelForMatching: 'NUMBER_VALUE',
    MaxAllowedRuleLevelForMerging: 'NUMBER_VALUE'
  },
  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. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains.

      After the Identity Resolution Job completes, use the GetMatches API to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from S3.

      • Enabledrequired — (Boolean)

        The flag that enables the matching process of duplicate profiles.

      • JobSchedule — (map)

        The day and time when do you want to start the Identity Resolution Job every week.

        • DayOfTheWeekrequired — (String)

          The day when the Identity Resolution Job should run every week.

          Possible values include:
          • "SUNDAY"
          • "MONDAY"
          • "TUESDAY"
          • "WEDNESDAY"
          • "THURSDAY"
          • "FRIDAY"
          • "SATURDAY"
        • Timerequired — (String)

          The time when the Identity Resolution Job should run every week.

      • AutoMerging — (map)

        Configuration information about the auto-merging process.

        • Enabledrequired — (Boolean)

          The flag that enables the auto-merging of duplicate profiles.

        • Consolidation — (map)

          A list of matching attributes that represent matching criteria. If two profiles meet at least one of the requirements in the matching attributes list, they will be merged.

          • MatchingAttributesListrequired — (Array<Array<String>>)

            A list of matching criteria.

        • ConflictResolution — (map)

          How the auto-merging process should resolve conflicts between different profiles. For example, if Profile A and Profile B have the same FirstName and LastName (and that is the matching criteria), which EmailAddress should be used?

          • ConflictResolvingModelrequired — (String)

            How the auto-merging process should resolve conflicts between different profiles.

            • RECENCY: Uses the data that was most recently updated.

            • SOURCE: Uses the data from a specific source. For example, if a company has been aquired or two departments have merged, data from the specified source is used. If two duplicate profiles are from the same source, then RECENCY is used again.

            Possible values include:
            • "RECENCY"
            • "SOURCE"
          • SourceName — (String)

            The ObjectType name that is used to resolve profile merging conflicts when choosing SOURCE as the ConflictResolvingModel.

        • MinAllowedConfidenceScoreForMerging — (Float)

          A number between 0 and 1 that represents the minimum confidence score required for profiles within a matching group to be merged during the auto-merge process. A higher score means higher similarity required to merge profiles.

      • ExportingConfig — (map)

        Configuration information for exporting Identity Resolution results, for example, to an S3 bucket.

        • S3Exporting — (map)

          The S3 location where Identity Resolution Jobs write result files.

          • S3BucketNamerequired — (String)

            The name of the S3 bucket where Identity Resolution Jobs write result files.

          • S3KeyName — (String)

            The S3 key name of the location where Identity Resolution Jobs write result files.

    • RuleBasedMatching — (map)

      The process of matching duplicate profiles using the Rule-Based matching. If RuleBasedMatching = true, Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration in the RuleBasedMatchingRequest. You can use the ListRuleBasedMatches and GetSimilarProfiles API to return and review the results. Also, if you have configured ExportingConfig in the RuleBasedMatchingRequest, you can download the results from S3.

      • Enabledrequired — (Boolean)

        The flag that enables the rule-based matching process of duplicate profiles.

      • MatchingRules — (Array<map>)

        Configures how the rule-based matching process should match profiles. You can have up to 15 MatchingRule in the MatchingRules.

        • Rulerequired — (Array<String>)

          A single rule level of the MatchRules. Configures how the rule-based matching process should match profiles.

      • MaxAllowedRuleLevelForMerging — (Integer)

        MatchingRule

      • MaxAllowedRuleLevelForMatching — (Integer)

        Indicates the maximum allowed rule level.

      • AttributeTypesSelector — (map)

        Configures information about the AttributeTypesSelector where the rule-based identity resolution uses to match profiles.

        • AttributeMatchingModelrequired — (String)

          Configures the AttributeMatchingModel, you can either choose ONE_TO_ONE or MANY_TO_MANY.

          Possible values include:
          • "ONE_TO_ONE"
          • "MANY_TO_MANY"
        • Address — (Array<String>)

          The Address type. You can choose from Address, BusinessAddress, MaillingAddress, and ShippingAddress.

          You only can use the Address type in the MatchingRule. For example, if you want to match profile based on BusinessAddress.City or MaillingAddress.City, you need to choose the BusinessAddress and the MaillingAddress to represent the Address type and specify the Address.City on the matching rule.

        • PhoneNumber — (Array<String>)

          The PhoneNumber type. You can choose from PhoneNumber, HomePhoneNumber, and MobilePhoneNumber.

          You only can use the PhoneNumber type in the MatchingRule. For example, if you want to match a profile based on Phone or HomePhone, you need to choose the Phone and the HomePhone to represent the PhoneNumber type and only specify the PhoneNumber on the matching rule.

        • EmailAddress — (Array<String>)

          The Email type. You can choose from EmailAddress, BusinessEmailAddress and PersonalEmailAddress.

          You only can use the EmailAddress type in the MatchingRule. For example, if you want to match profile based on PersonalEmailAddress or BusinessEmailAddress, you need to choose the PersonalEmailAddress and the BusinessEmailAddress to represent the EmailAddress type and only specify the EmailAddress on the matching rule.

      • ConflictResolution — (map)

        How the auto-merging process should resolve conflicts between different profiles.

        • ConflictResolvingModelrequired — (String)

          How the auto-merging process should resolve conflicts between different profiles.

          • RECENCY: Uses the data that was most recently updated.

          • SOURCE: Uses the data from a specific source. For example, if a company has been aquired or two departments have merged, data from the specified source is used. If two duplicate profiles are from the same source, then RECENCY is used again.

          Possible values include:
          • "RECENCY"
          • "SOURCE"
        • SourceName — (String)

          The ObjectType name that is used to resolve profile merging conflicts when choosing SOURCE as the ConflictResolvingModel.

      • ExportingConfig — (map)

        Configuration information about the S3 bucket where Identity Resolution Jobs writes result files.

        Note: You need to give Customer Profiles service principal write permission to your S3 bucket. Otherwise, you'll get an exception in the API response. For an example policy, see Amazon Connect Customer Profiles cross-service confused deputy prevention.
        • S3Exporting — (map)

          The S3 location where Identity Resolution Jobs write result files.

          • S3BucketNamerequired — (String)

            The name of the S3 bucket where Identity Resolution Jobs write result files.

          • S3KeyName — (String)

            The S3 key name of the location where Identity Resolution Jobs write result files.

    • 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. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains.

        After the Identity Resolution Job completes, use the GetMatches API to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from S3.

        • Enabled — (Boolean)

          The flag that enables the matching process of duplicate profiles.

        • JobSchedule — (map)

          The day and time when do you want to start the Identity Resolution Job every week.

          • DayOfTheWeekrequired — (String)

            The day when the Identity Resolution Job should run every week.

            Possible values include:
            • "SUNDAY"
            • "MONDAY"
            • "TUESDAY"
            • "WEDNESDAY"
            • "THURSDAY"
            • "FRIDAY"
            • "SATURDAY"
          • Timerequired — (String)

            The time when the Identity Resolution Job should run every week.

        • AutoMerging — (map)

          Configuration information about the auto-merging process.

          • Enabledrequired — (Boolean)

            The flag that enables the auto-merging of duplicate profiles.

          • Consolidation — (map)

            A list of matching attributes that represent matching criteria. If two profiles meet at least one of the requirements in the matching attributes list, they will be merged.

            • MatchingAttributesListrequired — (Array<Array<String>>)

              A list of matching criteria.

          • ConflictResolution — (map)

            How the auto-merging process should resolve conflicts between different profiles. For example, if Profile A and Profile B have the same FirstName and LastName (and that is the matching criteria), which EmailAddress should be used?

            • ConflictResolvingModelrequired — (String)

              How the auto-merging process should resolve conflicts between different profiles.

              • RECENCY: Uses the data that was most recently updated.

              • SOURCE: Uses the data from a specific source. For example, if a company has been aquired or two departments have merged, data from the specified source is used. If two duplicate profiles are from the same source, then RECENCY is used again.

              Possible values include:
              • "RECENCY"
              • "SOURCE"
            • SourceName — (String)

              The ObjectType name that is used to resolve profile merging conflicts when choosing SOURCE as the ConflictResolvingModel.

          • MinAllowedConfidenceScoreForMerging — (Float)

            A number between 0 and 1 that represents the minimum confidence score required for profiles within a matching group to be merged during the auto-merge process. A higher score means higher similarity required to merge profiles.

        • ExportingConfig — (map)

          Configuration information for exporting Identity Resolution results, for example, to an S3 bucket.

          • S3Exporting — (map)

            The S3 location where Identity Resolution Jobs write result files.

            • S3BucketNamerequired — (String)

              The name of the S3 bucket where Identity Resolution Jobs write result files.

            • S3KeyName — (String)

              The S3 key name of the location where Identity Resolution Jobs write result files.

      • RuleBasedMatching — (map)

        The process of matching duplicate profiles using the Rule-Based matching. If RuleBasedMatching = true, Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration in the RuleBasedMatchingRequest. You can use the ListRuleBasedMatches and GetSimilarProfiles API to return and review the results. Also, if you have configured ExportingConfig in the RuleBasedMatchingRequest, you can download the results from S3.

        • Enabled — (Boolean)

          The flag that enables the rule-based matching process of duplicate profiles.

        • MatchingRules — (Array<map>)

          Configures how the rule-based matching process should match profiles. You can have up to 15 MatchingRule in the MatchingRules.

          • Rulerequired — (Array<String>)

            A single rule level of the MatchRules. Configures how the rule-based matching process should match profiles.

        • Status — (String)

          PENDING

          • The first status after configuration a rule-based matching rule. If it is an existing domain, the rule-based Identity Resolution waits one hour before creating the matching rule. If it is a new domain, the system will skip the PENDING stage.

          IN_PROGRESS

          • The system is creating the rule-based matching rule. Under this status, the system is evaluating the existing data and you can no longer change the Rule-based matching configuration.

          ACTIVE

          • The rule is ready to use. You can change the rule a day after the status is in ACTIVE.

          Possible values include:
          • "PENDING"
          • "IN_PROGRESS"
          • "ACTIVE"
        • MaxAllowedRuleLevelForMerging — (Integer)

          MatchingRule

        • MaxAllowedRuleLevelForMatching — (Integer)

          Indicates the maximum allowed rule level.

        • AttributeTypesSelector — (map)

          Configures information about the AttributeTypesSelector where the rule-based identity resolution uses to match profiles.

          • AttributeMatchingModelrequired — (String)

            Configures the AttributeMatchingModel, you can either choose ONE_TO_ONE or MANY_TO_MANY.

            Possible values include:
            • "ONE_TO_ONE"
            • "MANY_TO_MANY"
          • Address — (Array<String>)

            The Address type. You can choose from Address, BusinessAddress, MaillingAddress, and ShippingAddress.

            You only can use the Address type in the MatchingRule. For example, if you want to match profile based on BusinessAddress.City or MaillingAddress.City, you need to choose the BusinessAddress and the MaillingAddress to represent the Address type and specify the Address.City on the matching rule.

          • PhoneNumber — (Array<String>)

            The PhoneNumber type. You can choose from PhoneNumber, HomePhoneNumber, and MobilePhoneNumber.

            You only can use the PhoneNumber type in the MatchingRule. For example, if you want to match a profile based on Phone or HomePhone, you need to choose the Phone and the HomePhone to represent the PhoneNumber type and only specify the PhoneNumber on the matching rule.

          • EmailAddress — (Array<String>)

            The Email type. You can choose from EmailAddress, BusinessEmailAddress and PersonalEmailAddress.

            You only can use the EmailAddress type in the MatchingRule. For example, if you want to match profile based on PersonalEmailAddress or BusinessEmailAddress, you need to choose the PersonalEmailAddress and the BusinessEmailAddress to represent the EmailAddress type and only specify the EmailAddress on the matching rule.

        • ConflictResolution — (map)

          How the auto-merging process should resolve conflicts between different profiles.

          • ConflictResolvingModelrequired — (String)

            How the auto-merging process should resolve conflicts between different profiles.

            • RECENCY: Uses the data that was most recently updated.

            • SOURCE: Uses the data from a specific source. For example, if a company has been aquired or two departments have merged, data from the specified source is used. If two duplicate profiles are from the same source, then RECENCY is used again.

            Possible values include:
            • "RECENCY"
            • "SOURCE"
          • SourceName — (String)

            The ObjectType name that is used to resolve profile merging conflicts when choosing SOURCE as the ConflictResolvingModel.

        • ExportingConfig — (map)

          Configuration information about the S3 bucket where Identity Resolution Jobs writes result files.

          Note: You need to give Customer Profiles service principal write permission to your S3 bucket. Otherwise, you'll get an exception in the API response. For an example policy, see Amazon Connect Customer Profiles cross-service confused deputy prevention.
          • S3Exporting — (map)

            The S3 location where Identity Resolution Jobs write result files.

            • S3BucketNamerequired — (String)

              The name of the S3 bucket where Identity Resolution Jobs write result files.

            • S3KeyName — (String)

              The S3 key name of the location where Identity Resolution Jobs write result files.

      • 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.

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

Creates an event stream, which is a subscription to real-time events, such as when profiles are created and updated through Amazon Connect Customer Profiles.

Each event stream can be associated with only one Kinesis Data Stream destination in the same region and Amazon Web Services account as the customer profiles domain

Service Reference:

Examples:

Calling the createEventStream operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  EventStreamName: 'STRING_VALUE', /* required */
  Uri: 'STRING_VALUE', /* required */
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
customerprofiles.createEventStream(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 StreamARN of the destination to deliver profile events to. For example, arn:aws:kinesis:region:account-id:stream/stream-name

    • EventStreamName — (String)

      The name of the event stream.

    • 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:

      • EventStreamArn — (String)

        A unique identifier for the event stream.

      • 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.

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

Creates an integration workflow. An integration workflow is an async process which ingests historic data and sets up an integration for ongoing updates. The supported Amazon AppFlow sources are Salesforce, ServiceNow, and Marketo.

Service Reference:

Examples:

Calling the createIntegrationWorkflow operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  IntegrationConfig: { /* required */
    AppflowIntegration: {
      FlowDefinition: { /* required */
        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'
      },
      Batches: [
        {
          EndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
          StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789 /* required */
        },
        /* more items */
      ]
    }
  },
  ObjectTypeName: 'STRING_VALUE', /* required */
  RoleArn: 'STRING_VALUE', /* required */
  WorkflowType: APPFLOW_INTEGRATION, /* required */
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
customerprofiles.createIntegrationWorkflow(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.

    • WorkflowType — (String)

      The type of workflow. The only supported value is APPFLOW_INTEGRATION.

      Possible values include:
      • "APPFLOW_INTEGRATION"
    • IntegrationConfig — (map)

      Configuration data for integration workflow.

      • AppflowIntegration — (map)

        Configuration data for APPFLOW_INTEGRATION workflow type.

        • FlowDefinitionrequired — (map)

          The configurations that control how Customer Profiles retrieves data from the source, Amazon AppFlow. Customer Profiles uses this information to create an AppFlow flow on behalf of customers.

          • 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.

        • Batches — (Array<map>)

          Batches in workflow of type APPFLOW_INTEGRATION.

          • StartTimerequired — (Date)

            Start time of batch to split ingestion.

          • EndTimerequired — (Date)

            End time of batch to split ingestion.

    • ObjectTypeName — (String)

      The name of the profile object type.

    • RoleArn — (String)

      The Amazon Resource Name (ARN) of the IAM role. Customer Profiles assumes this role to create resources on your behalf as part of workflow execution.

    • 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:

      • WorkflowId — (String)

        Unique identifier for the workflow.

      • Message — (String)

        A message indicating create request was received.

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,
  GenderString: 'STRING_VALUE',
  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,
  PartyTypeString: 'STRING_VALUE',
  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.

    • PartyTypeString — (String)

      An alternative to PartyType which accepts any string as input.

    • GenderString — (String)

      An alternative to Gender which accepts any string as input.

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.

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

Deletes an existing calculated attribute definition. Note that deleting a default calculated attribute is possible, however once deleted, you will be unable to undo that action and will need to recreate it on your own using the CreateCalculatedAttributeDefinition API if you want it back.

Examples:

Calling the deleteCalculatedAttributeDefinition operation

var params = {
  CalculatedAttributeName: 'STRING_VALUE', /* required */
  DomainName: 'STRING_VALUE' /* required */
};
customerprofiles.deleteCalculatedAttributeDefinition(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.

    • CalculatedAttributeName — (String)

      The unique name of the calculated attribute.

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.

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.

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

Disables and deletes the specified event stream.

Service Reference:

Examples:

Calling the deleteEventStream operation

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

Parameters:

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

      The unique name of the domain.

    • EventStreamName — (String)

      The name of the event stream

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.

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.

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

Deletes the specified workflow and all its corresponding resources. This is an async process.

Service Reference:

Examples:

Calling the deleteWorkflow operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  WorkflowId: 'STRING_VALUE' /* required */
};
customerprofiles.deleteWorkflow(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.

    • WorkflowId — (String)

      Unique identifier for the workflow.

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.

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

The process of detecting profile object type mapping by using given objects.

Service Reference:

Examples:

Calling the detectProfileObjectType operation

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

      • DetectedProfileObjectTypes — (Array<map>)

        Detected ProfileObjectType mappings from given objects. A maximum of one mapping is supported.

        • SourceLastUpdatedTimestampFormat — (String)

          The format of sourceLastUpdatedTimestamp that was detected in fields.

        • Fields — (map<map>)

          A map of the name and the 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 a 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, ASSET, CASE, or ORDER means that this key can be used to tie an object to a PROFILE, ASSET, CASE, or ORDER respectively. 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.

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

Tests the auto-merging settings of your Identity Resolution Job without merging your data. It randomly selects a sample of matching groups from the existing matching results, and applies the automerging settings that you provided. You can then view the number of profiles in the sample, the number of matches, and the number of profiles identified to be merged. This enables you to evaluate the accuracy of the attributes in your matching list.

You can't view which profiles are matched and would be merged.

We strongly recommend you use this API to do a dry run of the automerging process before running the Identity Resolution Job. Include at least two matching attributes. If your matching list includes too few attributes (such as only FirstName or only LastName), there may be a large number of matches. This increases the chances of erroneous merges.

Service Reference:

Examples:

Calling the getAutoMergingPreview operation

var params = {
  ConflictResolution: { /* required */
    ConflictResolvingModel: RECENCY | SOURCE, /* required */
    SourceName: 'STRING_VALUE'
  },
  Consolidation: { /* required */
    MatchingAttributesList: [ /* required */
      [
        'STRING_VALUE',
        /* more items */
      ],
      /* more items */
    ]
  },
  DomainName: 'STRING_VALUE', /* required */
  MinAllowedConfidenceScoreForMerging: 'NUMBER_VALUE'
};
customerprofiles.getAutoMergingPreview(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.

    • Consolidation — (map)

      A list of matching attributes that represent matching criteria.

      • MatchingAttributesListrequired — (Array<Array<String>>)

        A list of matching criteria.

    • ConflictResolution — (map)

      How the auto-merging process should resolve conflicts between different profiles.

      • ConflictResolvingModelrequired — (String)

        How the auto-merging process should resolve conflicts between different profiles.

        • RECENCY: Uses the data that was most recently updated.

        • SOURCE: Uses the data from a specific source. For example, if a company has been aquired or two departments have merged, data from the specified source is used. If two duplicate profiles are from the same source, then RECENCY is used again.

        Possible values include:
        • "RECENCY"
        • "SOURCE"
      • SourceName — (String)

        The ObjectType name that is used to resolve profile merging conflicts when choosing SOURCE as the ConflictResolvingModel.

    • MinAllowedConfidenceScoreForMerging — (Float)

      Minimum confidence score required for profiles within a matching group to be merged during the auto-merge process.

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.

      • NumberOfMatchesInSample — (Integer)

        The number of match groups in the domain that have been reviewed in this preview dry run.

      • NumberOfProfilesInSample — (Integer)

        The number of profiles found in this preview dry run.

      • NumberOfProfilesWillBeMerged — (Integer)

        The number of profiles that would be merged if this wasn't a preview dry run.

Returns:

  • (AWS.Request)

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

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

Provides more information on a calculated attribute definition for Customer Profiles.

Examples:

Calling the getCalculatedAttributeDefinition operation

var params = {
  CalculatedAttributeName: 'STRING_VALUE', /* required */
  DomainName: 'STRING_VALUE' /* required */
};
customerprofiles.getCalculatedAttributeDefinition(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.

    • CalculatedAttributeName — (String)

      The unique name of the calculated attribute.

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:

      • CalculatedAttributeName — (String)

        The unique name of the calculated attribute.

      • DisplayName — (String)

        The display name of the calculated attribute.

      • Description — (String)

        The description of the calculated attribute.

      • CreatedAt — (Date)

        The timestamp of when the calculated attribute definition was created.

      • LastUpdatedAt — (Date)

        The timestamp of when the calculated attribute definition was most recently edited.

      • Statistic — (String)

        The aggregation operation to perform for the calculated attribute.

        Possible values include:
        • "FIRST_OCCURRENCE"
        • "LAST_OCCURRENCE"
        • "COUNT"
        • "SUM"
        • "MINIMUM"
        • "MAXIMUM"
        • "AVERAGE"
        • "MAX_OCCURRENCE"
      • Conditions — (map)

        The conditions including range, object count, and threshold for the calculated attribute.

        • Range — (map)

          The relative time period over which data is included in the aggregation.

          • Valuerequired — (Integer)

            The amount of time of the specified unit.

          • Unitrequired — (String)

            The unit of time.

            Possible values include:
            • "DAYS"
        • ObjectCount — (Integer)

          The number of profile objects used for the calculated attribute.

        • Threshold — (map)

          The threshold for the calculated attribute.

          • Valuerequired — (String)

            The value of the threshold.

          • Operatorrequired — (String)

            The operator of the threshold.

            Possible values include:
            • "EQUAL_TO"
            • "GREATER_THAN"
            • "LESS_THAN"
            • "NOT_EQUAL_TO"
      • AttributeDetails — (map)

        Mathematical expression and a list of attribute items specified in that expression.

        • Attributesrequired — (Array<map>)

          A list of attribute items specified in the mathematical expression.

          • Namerequired — (String)

            The name of an attribute defined in a profile object type.

        • Expressionrequired — (String)

          Mathematical expression that is performed on attribute items provided in the attribute list. Each element in the expression should follow the structure of \"{ObjectTypeName.AttributeName}\".

      • 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.

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

Retrieve a calculated attribute for a customer profile.

Examples:

Calling the getCalculatedAttributeForProfile operation

var params = {
  CalculatedAttributeName: 'STRING_VALUE', /* required */
  DomainName: 'STRING_VALUE', /* required */
  ProfileId: 'STRING_VALUE' /* required */
};
customerprofiles.getCalculatedAttributeForProfile(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.

    • CalculatedAttributeName — (String)

      The unique name of the calculated attribute.

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:

      • CalculatedAttributeName — (String)

        The unique name of the calculated attribute.

      • DisplayName — (String)

        The display name of the calculated attribute.

      • IsDataPartial — (String)

        Indicates whether the calculated attribute’s value is based on partial data. If data is partial, it is set to true.

      • Value — (String)

        The value of the calculated attribute.

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. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains.

        After the Identity Resolution Job completes, use the GetMatches API to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from S3.

        • Enabled — (Boolean)

          The flag that enables the matching process of duplicate profiles.

        • JobSchedule — (map)

          The day and time when do you want to start the Identity Resolution Job every week.

          • DayOfTheWeekrequired — (String)

            The day when the Identity Resolution Job should run every week.

            Possible values include:
            • "SUNDAY"
            • "MONDAY"
            • "TUESDAY"
            • "WEDNESDAY"
            • "THURSDAY"
            • "FRIDAY"
            • "SATURDAY"
          • Timerequired — (String)

            The time when the Identity Resolution Job should run every week.

        • AutoMerging — (map)

          Configuration information about the auto-merging process.

          • Enabledrequired — (Boolean)

            The flag that enables the auto-merging of duplicate profiles.

          • Consolidation — (map)

            A list of matching attributes that represent matching criteria. If two profiles meet at least one of the requirements in the matching attributes list, they will be merged.

            • MatchingAttributesListrequired — (Array<Array<String>>)

              A list of matching criteria.

          • ConflictResolution — (map)

            How the auto-merging process should resolve conflicts between different profiles. For example, if Profile A and Profile B have the same FirstName and LastName (and that is the matching criteria), which EmailAddress should be used?

            • ConflictResolvingModelrequired — (String)

              How the auto-merging process should resolve conflicts between different profiles.

              • RECENCY: Uses the data that was most recently updated.

              • SOURCE: Uses the data from a specific source. For example, if a company has been aquired or two departments have merged, data from the specified source is used. If two duplicate profiles are from the same source, then RECENCY is used again.

              Possible values include:
              • "RECENCY"
              • "SOURCE"
            • SourceName — (String)

              The ObjectType name that is used to resolve profile merging conflicts when choosing SOURCE as the ConflictResolvingModel.

          • MinAllowedConfidenceScoreForMerging — (Float)

            A number between 0 and 1 that represents the minimum confidence score required for profiles within a matching group to be merged during the auto-merge process. A higher score means higher similarity required to merge profiles.

        • ExportingConfig — (map)

          Configuration information for exporting Identity Resolution results, for example, to an S3 bucket.

          • S3Exporting — (map)

            The S3 location where Identity Resolution Jobs write result files.

            • S3BucketNamerequired — (String)

              The name of the S3 bucket where Identity Resolution Jobs write result files.

            • S3KeyName — (String)

              The S3 key name of the location where Identity Resolution Jobs write result files.

      • RuleBasedMatching — (map)

        The process of matching duplicate profiles using the Rule-Based matching. If RuleBasedMatching = true, Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration in the RuleBasedMatchingRequest. You can use the ListRuleBasedMatches and GetSimilarProfiles API to return and review the results. Also, if you have configured ExportingConfig in the RuleBasedMatchingRequest, you can download the results from S3.

        • Enabled — (Boolean)

          The flag that enables the rule-based matching process of duplicate profiles.

        • MatchingRules — (Array<map>)

          Configures how the rule-based matching process should match profiles. You can have up to 15 MatchingRule in the MatchingRules.

          • Rulerequired — (Array<String>)

            A single rule level of the MatchRules. Configures how the rule-based matching process should match profiles.

        • Status — (String)

          PENDING

          • The first status after configuration a rule-based matching rule. If it is an existing domain, the rule-based Identity Resolution waits one hour before creating the matching rule. If it is a new domain, the system will skip the PENDING stage.

          IN_PROGRESS

          • The system is creating the rule-based matching rule. Under this status, the system is evaluating the existing data and you can no longer change the Rule-based matching configuration.

          ACTIVE

          • The rule is ready to use. You can change the rule a day after the status is in ACTIVE.

          Possible values include:
          • "PENDING"
          • "IN_PROGRESS"
          • "ACTIVE"
        • MaxAllowedRuleLevelForMerging — (Integer)

          MatchingRule

        • MaxAllowedRuleLevelForMatching — (Integer)

          Indicates the maximum allowed rule level.

        • AttributeTypesSelector — (map)

          Configures information about the AttributeTypesSelector where the rule-based identity resolution uses to match profiles.

          • AttributeMatchingModelrequired — (String)

            Configures the AttributeMatchingModel, you can either choose ONE_TO_ONE or MANY_TO_MANY.

            Possible values include:
            • "ONE_TO_ONE"
            • "MANY_TO_MANY"
          • Address — (Array<String>)

            The Address type. You can choose from Address, BusinessAddress, MaillingAddress, and ShippingAddress.

            You only can use the Address type in the MatchingRule. For example, if you want to match profile based on BusinessAddress.City or MaillingAddress.City, you need to choose the BusinessAddress and the MaillingAddress to represent the Address type and specify the Address.City on the matching rule.

          • PhoneNumber — (Array<String>)

            The PhoneNumber type. You can choose from PhoneNumber, HomePhoneNumber, and MobilePhoneNumber.

            You only can use the PhoneNumber type in the MatchingRule. For example, if you want to match a profile based on Phone or HomePhone, you need to choose the Phone and the HomePhone to represent the PhoneNumber type and only specify the PhoneNumber on the matching rule.

          • EmailAddress — (Array<String>)

            The Email type. You can choose from EmailAddress, BusinessEmailAddress and PersonalEmailAddress.

            You only can use the EmailAddress type in the MatchingRule. For example, if you want to match profile based on PersonalEmailAddress or BusinessEmailAddress, you need to choose the PersonalEmailAddress and the BusinessEmailAddress to represent the EmailAddress type and only specify the EmailAddress on the matching rule.

        • ConflictResolution — (map)

          How the auto-merging process should resolve conflicts between different profiles.

          • ConflictResolvingModelrequired — (String)

            How the auto-merging process should resolve conflicts between different profiles.

            • RECENCY: Uses the data that was most recently updated.

            • SOURCE: Uses the data from a specific source. For example, if a company has been aquired or two departments have merged, data from the specified source is used. If two duplicate profiles are from the same source, then RECENCY is used again.

            Possible values include:
            • "RECENCY"
            • "SOURCE"
          • SourceName — (String)

            The ObjectType name that is used to resolve profile merging conflicts when choosing SOURCE as the ConflictResolvingModel.

        • ExportingConfig — (map)

          Configuration information about the S3 bucket where Identity Resolution Jobs writes result files.

          Note: You need to give Customer Profiles service principal write permission to your S3 bucket. Otherwise, you'll get an exception in the API response. For an example policy, see Amazon Connect Customer Profiles cross-service confused deputy prevention.
          • S3Exporting — (map)

            The S3 location where Identity Resolution Jobs write result files.

            • S3BucketNamerequired — (String)

              The name of the S3 bucket where Identity Resolution Jobs write result files.

            • S3KeyName — (String)

              The S3 key name of the location where Identity Resolution Jobs write result files.

      • 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.

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

Returns information about the specified event stream in a specific domain.

Service Reference:

Examples:

Calling the getEventStream operation

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

Parameters:

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

      The unique name of the domain.

    • EventStreamName — (String)

      The name of the event stream provided during create operations.

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.

      • EventStreamArn — (String)

        A unique identifier for the event stream.

      • CreatedAt — (Date)

        The timestamp of when the export was created.

      • State — (String)

        The operational state of destination stream for export.

        Possible values include:
        • "RUNNING"
        • "STOPPED"
      • StoppedSince — (Date)

        The timestamp when the State changed to STOPPED.

      • DestinationDetails — (map)

        Details regarding the Kinesis stream.

        • Urirequired — (String)

          The StreamARN of the destination to deliver profile events to. For example, arn:aws:kinesis:region:account-id:stream/stream-name.

        • Statusrequired — (String)

          The status of enabling the Kinesis stream as a destination for export.

          Possible values include:
          • "HEALTHY"
          • "UNHEALTHY"
        • UnhealthySince — (Date)

          The timestamp when the status last changed to UNHEALHY.

        • Message — (String)

          The human-readable string that corresponds to the error or success while enabling the streaming destination.

      • 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.

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

Returns information about an Identity Resolution Job in a specific domain.

Identity Resolution Jobs are set up using the Amazon Connect admin console. For more information, see Use Identity Resolution to consolidate similar profiles.

Service Reference:

Examples:

Calling the getIdentityResolutionJob operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  JobId: 'STRING_VALUE' /* required */
};
customerprofiles.getIdentityResolutionJob(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.

    • JobId — (String)

      The unique identifier of the Identity Resolution Job.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • DomainName — (String)

        The unique name of the domain.

      • JobId — (String)

        The unique identifier of the Identity Resolution Job.

      • Status — (String)

        The status of the Identity Resolution Job.

        • PENDING: The Identity Resolution Job is scheduled but has not started yet. If you turn off the Identity Resolution feature in your domain, jobs in the PENDING state are deleted.

        • PREPROCESSING: The Identity Resolution Job is loading your data.

        • FIND_MATCHING: The Identity Resolution Job is using the machine learning model to identify profiles that belong to the same matching group.

        • MERGING: The Identity Resolution Job is merging duplicate profiles.

        • COMPLETED: The Identity Resolution Job completed successfully.

        • PARTIAL_SUCCESS: There's a system error and not all of the data is merged. The Identity Resolution Job writes a message indicating the source of the problem.

        • FAILED: The Identity Resolution Job did not merge any data. It writes a message indicating the source of the problem.

        Possible values include:
        • "PENDING"
        • "PREPROCESSING"
        • "FIND_MATCHING"
        • "MERGING"
        • "COMPLETED"
        • "PARTIAL_SUCCESS"
        • "FAILED"
      • Message — (String)

        The error messages that are generated when the Identity Resolution Job runs.

      • JobStartTime — (Date)

        The timestamp of when the Identity Resolution Job was started or will be started.

      • JobEndTime — (Date)

        The timestamp of when the Identity Resolution Job was completed.

      • LastUpdatedAt — (Date)

        The timestamp of when the Identity Resolution Job was most recently edited.

      • JobExpirationTime — (Date)

        The timestamp of when the Identity Resolution Job will expire.

      • AutoMerging — (map)

        Configuration settings for how to perform the auto-merging of profiles.

        • Enabledrequired — (Boolean)

          The flag that enables the auto-merging of duplicate profiles.

        • Consolidation — (map)

          A list of matching attributes that represent matching criteria. If two profiles meet at least one of the requirements in the matching attributes list, they will be merged.

          • MatchingAttributesListrequired — (Array<Array<String>>)

            A list of matching criteria.

        • ConflictResolution — (map)

          How the auto-merging process should resolve conflicts between different profiles. For example, if Profile A and Profile B have the same FirstName and LastName (and that is the matching criteria), which EmailAddress should be used?

          • ConflictResolvingModelrequired — (String)

            How the auto-merging process should resolve conflicts between different profiles.

            • RECENCY: Uses the data that was most recently updated.

            • SOURCE: Uses the data from a specific source. For example, if a company has been aquired or two departments have merged, data from the specified source is used. If two duplicate profiles are from the same source, then RECENCY is used again.

            Possible values include:
            • "RECENCY"
            • "SOURCE"
          • SourceName — (String)

            The ObjectType name that is used to resolve profile merging conflicts when choosing SOURCE as the ConflictResolvingModel.

        • MinAllowedConfidenceScoreForMerging — (Float)

          A number between 0 and 1 that represents the minimum confidence score required for profiles within a matching group to be merged during the auto-merge process. A higher score means higher similarity required to merge profiles.

      • ExportingLocation — (map)

        The S3 location where the Identity Resolution Job writes result files.

        • S3Exporting — (map)

          Information about the S3 location where Identity Resolution Jobs write result files.

          • S3BucketName — (String)

            The name of the S3 bucket name where Identity Resolution Jobs write result files.

          • S3KeyName — (String)

            The S3 key name of the location where Identity Resolution Jobs write result files.

      • JobStats — (map)

        Statistics about the Identity Resolution Job.

        • NumberOfProfilesReviewed — (Integer)

          The number of profiles reviewed.

        • NumberOfMatchesFound — (Integer)

          The number of matches found.

        • NumberOfMergesDone — (Integer)

          The number of merges completed.

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.

      • ObjectTypeNames — (map<String>)

        A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an ObjectTypeName (template) used to ingest the event. It supports the following event types: SegmentIdentify, ShopifyCreateCustomers, ShopifyUpdateCustomers, ShopifyCreateDraftOrders, ShopifyUpdateDraftOrders, ShopifyCreateOrders, and ShopifyUpdatedOrders.

      • WorkflowId — (String)

        Unique identifier for the workflow.

      • IsUnstructured — (Boolean)

        Boolean that shows if the Flow that's associated with the Integration is created in Amazon Appflow, or with ObjectTypeName equals _unstructured via API/CLI in flowDefinition.

Returns:

  • (AWS.Request)

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

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

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.

The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains.

After the Identity Resolution Job completes, use the GetMatches API to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from S3.

Amazon Connect uses the following profile attributes to identify matches:

  • PhoneNumber

  • HomePhoneNumber

  • BusinessPhoneNumber

  • MobilePhoneNumber

  • EmailAddress

  • PersonalEmailAddress

  • BusinessEmailAddress

  • FullName

For example, two or more profiles—with spelling mistakes such as John Doe and Jhn Doe, or different casing email addresses such as JOHN_DOE@ANYCOMPANY.COM and johndoe@anycompany.com, or different phone number formats such as 555-010-0000 and +1-555-010-0000—can be detected as belonging to the same customer John Doe and merged into a unified profile.

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.

        • ConfidenceScore — (Float)

          A number between 0 and 1, where a higher score means higher similarity. Examining match confidence scores lets you distinguish between groups of similar records in which the system is highly confident (which you may decide to merge), groups of similar records about which the system is uncertain (which you may decide to have reviewed by a human), and groups of similar records that the system deems to be unlikely (which you may decide to reject). Given confidence scores vary as per the data input, it should not be used an absolute measure of matching quality.

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.

      • SourceLastUpdatedTimestampFormat — (String)

        The format of your sourceLastUpdatedTimestamp that was previously set up.

      • 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, ASSET, CASE, or ORDER means that this key can be used to tie an object to a PROFILE, ASSET, CASE, or ORDER respectively. 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.

      • SourceLastUpdatedTimestampFormat — (String)

        The format of your sourceLastUpdatedTimestamp that was previously set up.

      • 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, ASSET, CASE, or ORDER means that this key can be used to tie an object to a PROFILE, ASSET, CASE, or ORDER respectively. 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.

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

Returns a set of profiles that belong to the same matching group using the matchId or profileId. You can also specify the type of matching that you want for finding similar profiles using either RULE_BASED_MATCHING or ML_BASED_MATCHING.

Service Reference:

Examples:

Calling the getSimilarProfiles operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  MatchType: RULE_BASED_MATCHING | ML_BASED_MATCHING, /* required */
  SearchKey: 'STRING_VALUE', /* required */
  SearchValue: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
customerprofiles.getSimilarProfiles(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 GetSimilarProfiles API call.

    • MaxResults — (Integer)

      The maximum number of objects returned per page.

    • DomainName — (String)

      The unique name of the domain.

    • MatchType — (String)

      Specify the type of matching to get similar profiles for.

      Possible values include:
      • "RULE_BASED_MATCHING"
      • "ML_BASED_MATCHING"
    • SearchKey — (String)

      The string indicating the search key to be used.

    • SearchValue — (String)

      The string based on SearchKey to be searched for similar profiles.

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:

      • ProfileIds — (Array<String>)

        Set of profileIds that belong to the same matching group.

      • MatchId — (String)

        The string matchId that the similar profiles belong to.

      • MatchType — (String)

        Specify the type of matching to get similar profiles for.

        Possible values include:
        • "RULE_BASED_MATCHING"
        • "ML_BASED_MATCHING"
      • RuleLevel — (Integer)

        The integer rule level that the profiles matched on.

      • ConfidenceScore — (Float)

        It only has value when the MatchType is ML_BASED_MATCHING.A number between 0 and 1, where a higher score means higher similarity. Examining match confidence scores lets you distinguish between groups of similar records in which the system is highly confident (which you may decide to merge), groups of similar records about which the system is uncertain (which you may decide to have reviewed by a human), and groups of similar records that the system deems to be unlikely (which you may decide to reject). Given confidence scores vary as per the data input, it should not be used as an absolute measure of matching quality.

      • NextToken — (String)

        The pagination token from the previous GetSimilarProfiles API call.

Returns:

  • (AWS.Request)

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

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

Get details of specified workflow.

Service Reference:

Examples:

Calling the getWorkflow operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  WorkflowId: 'STRING_VALUE' /* required */
};
customerprofiles.getWorkflow(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.

    • WorkflowId — (String)

      Unique identifier for the workflow.

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:

      • WorkflowId — (String)

        Unique identifier for the workflow.

      • WorkflowType — (String)

        The type of workflow. The only supported value is APPFLOW_INTEGRATION.

        Possible values include:
        • "APPFLOW_INTEGRATION"
      • Status — (String)

        Status of workflow execution.

        Possible values include:
        • "NOT_STARTED"
        • "IN_PROGRESS"
        • "COMPLETE"
        • "FAILED"
        • "SPLIT"
        • "RETRY"
        • "CANCELLED"
      • ErrorDescription — (String)

        Workflow error messages during execution (if any).

      • StartDate — (Date)

        The timestamp that represents when workflow execution started.

      • LastUpdatedAt — (Date)

        The timestamp that represents when workflow execution last updated.

      • Attributes — (map)

        Attributes provided for workflow execution.

        • AppflowIntegration — (map)

          Workflow attributes specific to APPFLOW_INTEGRATION workflow.

          • SourceConnectorTyperequired — (String)

            Specifies the source connector type, such as Salesforce, ServiceNow, and Marketo. Indicates source of ingestion.

            Possible values include:
            • "Salesforce"
            • "Marketo"
            • "Zendesk"
            • "Servicenow"
            • "S3"
          • ConnectorProfileNamerequired — (String)

            The name of the AppFlow connector profile used for ingestion.

          • RoleArn — (String)

            The Amazon Resource Name (ARN) of the IAM role. Customer Profiles assumes this role to create resources on your behalf as part of workflow execution.

      • Metrics — (map)

        Workflow specific execution metrics.

        • AppflowIntegration — (map)

          Workflow execution metrics for APPFLOW_INTEGRATION workflow.

          • RecordsProcessedrequired — (Integer)

            Number of records processed in APPFLOW_INTEGRATION workflow.

          • StepsCompletedrequired — (Integer)

            Total steps completed in APPFLOW_INTEGRATION workflow.

          • TotalStepsrequired — (Integer)

            Total steps in APPFLOW_INTEGRATION workflow.

Returns:

  • (AWS.Request)

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

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

Get granular list of steps in workflow.

Service Reference:

Examples:

Calling the getWorkflowSteps operation

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

    • WorkflowId — (String)

      Unique identifier for the workflow.

    • 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.

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:

      • WorkflowId — (String)

        Unique identifier for the workflow.

      • WorkflowType — (String)

        The type of workflow. The only supported value is APPFLOW_INTEGRATION.

        Possible values include:
        • "APPFLOW_INTEGRATION"
      • Items — (Array<map>)

        List containing workflow step details.

        • AppflowIntegration — (map)

          Workflow step information specific to APPFLOW_INTEGRATION workflow.

          • FlowNamerequired — (String)

            Name of the flow created during execution of workflow step. APPFLOW_INTEGRATION workflow type creates an appflow flow during workflow step execution on the customers behalf.

          • Statusrequired — (String)

            Workflow step status for APPFLOW_INTEGRATION workflow.

            Possible values include:
            • "NOT_STARTED"
            • "IN_PROGRESS"
            • "COMPLETE"
            • "FAILED"
            • "SPLIT"
            • "RETRY"
            • "CANCELLED"
          • ExecutionMessagerequired — (String)

            Message indicating execution of workflow step for APPFLOW_INTEGRATION workflow.

          • RecordsProcessedrequired — (Integer)

            Total number of records processed during execution of workflow step for APPFLOW_INTEGRATION workflow.

          • BatchRecordsStartTimerequired — (String)

            Start datetime of records pulled in batch during execution of workflow step for APPFLOW_INTEGRATION workflow.

          • BatchRecordsEndTimerequired — (String)

            End datetime of records pulled in batch during execution of workflow step for APPFLOW_INTEGRATION workflow.

          • CreatedAtrequired — (Date)

            Creation timestamp of workflow step for APPFLOW_INTEGRATION workflow.

          • LastUpdatedAtrequired — (Date)

            Last updated timestamp for workflow step for APPFLOW_INTEGRATION workflow.

      • NextToken — (String)

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

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 */
  IncludeHidden: true || false,
  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.

    • IncludeHidden — (Boolean)

      Boolean to indicate if hidden integration should be returned. Defaults to False.

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.

        • ObjectTypeName — (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.

        • ObjectTypeNames — (map<String>)

          A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an ObjectTypeName (template) used to ingest the event. It supports the following event types: SegmentIdentify, ShopifyCreateCustomers, ShopifyUpdateCustomers, ShopifyCreateDraftOrders, ShopifyUpdateDraftOrders, ShopifyCreateOrders, and ShopifyUpdatedOrders.

        • WorkflowId — (String)

          Unique identifier for the workflow.

        • IsUnstructured — (Boolean)

          Boolean that shows if the Flow that's associated with the Integration is created in Amazon Appflow, or with ObjectTypeName equals _unstructured via API/CLI in flowDefinition.

      • 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.

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

Lists calculated attribute definitions for Customer Profiles

Examples:

Calling the listCalculatedAttributeDefinitions operation

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

    • MaxResults — (Integer)

      The maximum number of calculated attribute definitions 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 calculated attribute definitions.

        • CalculatedAttributeName — (String)

          The unique name of the calculated attribute.

        • DisplayName — (String)

          The display name of the calculated attribute.

        • Description — (String)

          The threshold for the calculated attribute.

        • CreatedAt — (Date)

          The threshold for the calculated attribute.

        • LastUpdatedAt — (Date)

          The timestamp of when the calculated attribute definition 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 call to ListCalculatedAttributeDefinitions.

Returns:

  • (AWS.Request)

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

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

Retrieve a list of calculated attributes for a customer profile.

Examples:

Calling the listCalculatedAttributesForProfile operation

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

    • MaxResults — (Integer)

      The maximum number of calculated attributes returned per page.

    • DomainName — (String)

      The unique name of the domain.

    • 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 calculated attributes.

        • CalculatedAttributeName — (String)

          The unique name of the calculated attribute.

        • DisplayName — (String)

          The display name of the calculated attribute.

        • IsDataPartial — (String)

          Indicates whether the calculated attribute’s value is based on partial data. If data is partial, it is set to true.

        • Value — (String)

          The value of the calculated attribute.

      • NextToken — (String)

        The pagination token from the previous call to ListCalculatedAttributesForProfile.

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.

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

Returns a list of all the event streams in a specific domain.

Service Reference:

Examples:

Calling the listEventStreams operation

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

        Contains summary information about an EventStream.

        • DomainNamerequired — (String)

          The unique name of the domain.

        • EventStreamNamerequired — (String)

          The name of the event stream.

        • EventStreamArnrequired — (String)

          A unique identifier for the event stream.

        • Staterequired — (String)

          The operational state of destination stream for export.

          Possible values include:
          • "RUNNING"
          • "STOPPED"
        • StoppedSince — (Date)

          The timestamp when the State changed to STOPPED.

        • DestinationSummary — (map)

          Summary information about the Kinesis data stream.

          • Urirequired — (String)

            The StreamARN of the destination to deliver profile events to. For example, arn:aws:kinesis:region:account-id:stream/stream-name.

          • Statusrequired — (String)

            The status of enabling the Kinesis stream as a destination for export.

            Possible values include:
            • "HEALTHY"
            • "UNHEALTHY"
          • UnhealthySince — (Date)

            The timestamp when the status last changed to UNHEALHY.

        • 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.

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

Lists all of the Identity Resolution Jobs in your domain. The response sorts the list by JobStartTime.

Service Reference:

Examples:

Calling the listIdentityResolutionJobs operation

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

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:

      • IdentityResolutionJobsList — (Array<map>)

        A list of Identity Resolution Jobs.

        • DomainName — (String)

          The unique name of the domain.

        • JobId — (String)

          The unique identifier of the Identity Resolution Job.

        • Status — (String)

          The status of the Identity Resolution Job.

          • PENDING: The Identity Resolution Job is scheduled but has not started yet. If you turn off the Identity Resolution feature in your domain, jobs in the PENDING state are deleted.

          • PREPROCESSING: The Identity Resolution Job is loading your data.

          • FIND_MATCHING: The Identity Resolution Job is using the machine learning model to identify profiles that belong to the same matching group.

          • MERGING: The Identity Resolution Job is merging duplicate profiles.

          • COMPLETED: The Identity Resolution Job completed successfully.

          • PARTIAL_SUCCESS: There's a system error and not all of the data is merged. The Identity Resolution Job writes a message indicating the source of the problem.

          • FAILED: The Identity Resolution Job did not merge any data. It writes a message indicating the source of the problem.

          Possible values include:
          • "PENDING"
          • "PREPROCESSING"
          • "FIND_MATCHING"
          • "MERGING"
          • "COMPLETED"
          • "PARTIAL_SUCCESS"
          • "FAILED"
        • JobStartTime — (Date)

          The timestamp of when the job was started or will be started.

        • JobEndTime — (Date)

          The timestamp of when the job was completed.

        • JobStats — (map)

          Statistics about an Identity Resolution Job.

          • NumberOfProfilesReviewed — (Integer)

            The number of profiles reviewed.

          • NumberOfMatchesFound — (Integer)

            The number of matches found.

          • NumberOfMergesDone — (Integer)

            The number of merges completed.

        • ExportingLocation — (map)

          The S3 location where the Identity Resolution Job writes result files.

          • S3Exporting — (map)

            Information about the S3 location where Identity Resolution Jobs write result files.

            • S3BucketName — (String)

              The name of the S3 bucket name where Identity Resolution Jobs write result files.

            • S3KeyName — (String)

              The S3 key name of the location where Identity Resolution Jobs write result files.

        • Message — (String)

          The error messages that are generated when the Identity Resolution Job runs.

      • NextToken — (String)

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

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 */
  IncludeHidden: true || false,
  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.

    • IncludeHidden — (Boolean)

      Boolean to indicate if hidden integration should be returned. Defaults to False.

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.

        • ObjectTypeName — (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.

        • ObjectTypeNames — (map<String>)

          A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an ObjectTypeName (template) used to ingest the event. It supports the following event types: SegmentIdentify, ShopifyCreateCustomers, ShopifyUpdateCustomers, ShopifyCreateDraftOrders, ShopifyUpdateDraftOrders, ShopifyCreateOrders, and ShopifyUpdatedOrders.

        • WorkflowId — (String)

          Unique identifier for the workflow.

        • IsUnstructured — (Boolean)

          Boolean that shows if the Flow that's associated with the Integration is created in Amazon Appflow, or with ObjectTypeName equals _unstructured via API/CLI in flowDefinition.

      • 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',
  ObjectFilter: {
    KeyName: 'STRING_VALUE', /* required */
    Values: [ /* required */
      'STRING_VALUE',
      /* more items */
    ]
  }
};
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.

    • ObjectFilter — (map)

      Applies a filter to the response to include profile objects with the specified index values.

      • KeyNamerequired — (String)

        A searchable identifier of a profile object. The predefined keys you can use to search for _asset include: _assetId, _assetName, and _serialNumber. The predefined keys you can use to search for _case include: _caseId. The predefined keys you can use to search for _order include: _orderId.

      • Valuesrequired — (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 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.

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

Returns a set of MatchIds that belong to the given domain.

Service Reference:

Examples:

Calling the listRuleBasedMatches operation

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

    • MaxResults — (Integer)

      The maximum number of MatchIds returned 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:

      • MatchIds — (Array<String>)

        The list of MatchIds for the given domain.

      • NextToken — (String)

        The pagination token from the previous ListRuleBasedMatches 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.

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

Query to list all workflows.

Service Reference:

Examples:

Calling the listWorkflows operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  QueryEndDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  QueryStartDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  Status: NOT_STARTED | IN_PROGRESS | COMPLETE | FAILED | SPLIT | RETRY | CANCELLED,
  WorkflowType: APPFLOW_INTEGRATION
};
customerprofiles.listWorkflows(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.

    • WorkflowType — (String)

      The type of workflow. The only supported value is APPFLOW_INTEGRATION.

      Possible values include:
      • "APPFLOW_INTEGRATION"
    • Status — (String)

      Status of workflow execution.

      Possible values include:
      • "NOT_STARTED"
      • "IN_PROGRESS"
      • "COMPLETE"
      • "FAILED"
      • "SPLIT"
      • "RETRY"
      • "CANCELLED"
    • QueryStartDate — (Date)

      Retrieve workflows started after timestamp.

    • QueryEndDate — (Date)

      Retrieve workflows ended after timestamp.

    • 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.

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

        List containing workflow details.

        • WorkflowTyperequired — (String)

          The type of workflow. The only supported value is APPFLOW_INTEGRATION.

          Possible values include:
          • "APPFLOW_INTEGRATION"
        • WorkflowIdrequired — (String)

          Unique identifier for the workflow.

        • Statusrequired — (String)

          Status of workflow execution.

          Possible values include:
          • "NOT_STARTED"
          • "IN_PROGRESS"
          • "COMPLETE"
          • "FAILED"
          • "SPLIT"
          • "RETRY"
          • "CANCELLED"
        • StatusDescriptionrequired — (String)

          Description for workflow execution status.

        • CreatedAtrequired — (Date)

          Creation timestamp for workflow.

        • LastUpdatedAtrequired — (Date)

          Last updated timestamp for workflow.

      • NextToken — (String)

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

Returns:

  • (AWS.Request)

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

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

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.

To add or remove tags on an existing Integration, see TagResource / UntagResource.

Service Reference:

Examples:

Calling the putIntegration operation

var params = {
  DomainName: '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'
  },
  ObjectTypeName: 'STRING_VALUE',
  ObjectTypeNames: {
    '<string1To255>': 'STRING_VALUE',
    /* '<string1To255>': ... */
  },
  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.

    • ObjectTypeNames — (map<String>)

      A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an ObjectTypeName (template) used to ingest the event. It supports the following event types: SegmentIdentify, ShopifyCreateCustomers, ShopifyUpdateCustomers, ShopifyCreateDraftOrders, ShopifyUpdateDraftOrders, ShopifyCreateOrders, and ShopifyUpdatedOrders.

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.

      • ObjectTypeNames — (map<String>)

        A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an ObjectTypeName (template) used to ingest the event. It supports the following event types: SegmentIdentify, ShopifyCreateCustomers, ShopifyUpdateCustomers, ShopifyCreateDraftOrders, ShopifyUpdateDraftOrders, ShopifyCreateOrders, and ShopifyUpdatedOrders.

      • WorkflowId — (String)

        Unique identifier for the workflow.

      • IsUnstructured — (Boolean)

        Boolean that shows if the Flow that's associated with the Integration is created in Amazon Appflow, or with ObjectTypeName equals _unstructured via API/CLI in flowDefinition.

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 Record, 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 Contact Records 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.

To add or remove tags on an existing ObjectType, see TagResource/UntagResource.

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 | ASSET | CASE | UNIQUE | SECONDARY | LOOKUP_ONLY | NEW_ONLY | ORDER,
          /* more items */
        ]
      },
      /* more items */
    ],
    /* '<name>': ... */
  },
  SourceLastUpdatedTimestampFormat: 'STRING_VALUE',
  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. For some attributes in the request, the service will use the default value from the object template when TemplateId is present. If these attributes are present in the request, the service may return a BadRequestException. These attributes include: AllowProfileCreation, SourceLastUpdatedTimestampFormat, Fields, and Keys. For example, if AllowProfileCreation is set to true when TemplateId is set, the service may return a BadRequestException.

    • 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.

    • SourceLastUpdatedTimestampFormat — (String)

      The format of your sourceLastUpdatedTimestamp that was previously set up.

    • 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, ASSET, CASE, or ORDER means that this key can be used to tie an object to a PROFILE, ASSET, CASE, or ORDER respectively. 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.

      • SourceLastUpdatedTimestampFormat — (String)

        The format of your sourceLastUpdatedTimestamp that was previously set up in fields that were parsed using SimpleDateFormat. If you have sourceLastUpdatedTimestamp in your field, you must set up sourceLastUpdatedTimestampFormat.

      • 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, ASSET, CASE, or ORDER means that this key can be used to tie an object to a PROFILE, ASSET, CASE, or ORDER respectively. 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 using one or more predefined search keys (e.g., _fullName, _phone, _email, _account, etc.) and/or custom-defined search keys. A search key is a data type pair that consists of a KeyName and Values list.

This operation supports searching for profiles with a minimum of 1 key-value(s) pair and up to 5 key-value(s) pairs using either AND or OR logic.

Service Reference:

Examples:

Calling the searchProfiles operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  KeyName: 'STRING_VALUE', /* required */
  Values: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  AdditionalSearchKeys: [
    {
      KeyName: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  LogicalOperator: AND | OR,
  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.

      The default is 20 if this parameter is not included in the request.

    • 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, assetId, caseId, orderId, fullName, phone, email, ctrContactId, marketoLeadId, salesforceAccountId, salesforceContactId, salesforceAssetId, zendeskUserId, zendeskExternalId, zendeskTicketId, serviceNowSystemId, serviceNowIncidentId, segmentUserId, shopifyCustomerId, _shopifyOrderId.

    • Values — (Array<String>)

      A list of key values.

    • AdditionalSearchKeys — (Array<map>)

      A list of AdditionalSearchKey objects that are each searchable identifiers of a profile. Each AdditionalSearchKey object contains a KeyName and a list of Values associated with that specific key (i.e., a key-value(s) pair). These additional search keys will be used in conjunction with the LogicalOperator and the required KeyName and Values parameters to search for profiles that satisfy the search criteria.

      • KeyNamerequired — (String)

        A searchable identifier of a customer profile.

      • Valuesrequired — (Array<String>)

        A list of key values.

    • LogicalOperator — (String)

      Relationship between all specified search keys that will be used to search for profiles. This includes the required KeyName and Values parameters as well as any key-value(s) pairs specified in the AdditionalSearchKeys list.

      This parameter influences which profiles will be returned in the response in the following manner:

      • AND - The response only includes profiles that match all of the search keys.

      • OR - The response includes profiles that match at least one of the search keys.

      The OR relationship is the default behavior if this parameter is not included in the request.

      Possible values include:
      • "AND"
      • "OR"

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 Profiles matching the search criteria.

        • 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.

        • FoundByItems — (Array<map>)

          A list of items used to find a profile returned in a SearchProfiles response. An item is a key-value(s) pair that matches an attribute in the profile.

          If the optional AdditionalSearchKeys parameter was included in the SearchProfiles request, the FoundByItems list should be interpreted based on the LogicalOperator used in the request:

          • AND - The profile included in the response matched all of the search keys specified in the request. The FoundByItems will include all of the key-value(s) pairs that were specified in the request (as this is a requirement of AND search logic).

          • OR - The profile included in the response matched at least one of the search keys specified in the request. The FoundByItems will include each of the key-value(s) pairs that the profile was found by.

          The OR relationship is the default behavior if the LogicalOperator parameter is not included in the SearchProfiles request.

          • KeyName — (String)

            A searchable identifier of a customer profile.

          • Values — (Array<String>)

            A list of key values.

        • PartyTypeString — (String)

          An alternative to PartyType which accepts any string as input.

        • GenderString — (String)

          An alternative to Gender which accepts any string as input.

      • 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.

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

Updates an existing calculated attribute definition. When updating the Conditions, note that increasing the date range of a calculated attribute will not trigger inclusion of historical data greater than the current date range.

Examples:

Calling the updateCalculatedAttributeDefinition operation

var params = {
  CalculatedAttributeName: 'STRING_VALUE', /* required */
  DomainName: 'STRING_VALUE', /* required */
  Conditions: {
    ObjectCount: 'NUMBER_VALUE',
    Range: {
      Unit: DAYS, /* required */
      Value: 'NUMBER_VALUE' /* required */
    },
    Threshold: {
      Operator: EQUAL_TO | GREATER_THAN | LESS_THAN | NOT_EQUAL_TO, /* required */
      Value: 'STRING_VALUE' /* required */
    }
  },
  Description: 'STRING_VALUE',
  DisplayName: 'STRING_VALUE'
};
customerprofiles.updateCalculatedAttributeDefinition(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.

    • CalculatedAttributeName — (String)

      The unique name of the calculated attribute.

    • DisplayName — (String)

      The display name of the calculated attribute.

    • Description — (String)

      The description of the calculated attribute.

    • Conditions — (map)

      The conditions including range, object count, and threshold for the calculated attribute.

      • Range — (map)

        The relative time period over which data is included in the aggregation.

        • Valuerequired — (Integer)

          The amount of time of the specified unit.

        • Unitrequired — (String)

          The unit of time.

          Possible values include:
          • "DAYS"
      • ObjectCount — (Integer)

        The number of profile objects used for the calculated attribute.

      • Threshold — (map)

        The threshold for the calculated attribute.

        • Valuerequired — (String)

          The value of the threshold.

        • Operatorrequired — (String)

          The operator of the threshold.

          Possible values include:
          • "EQUAL_TO"
          • "GREATER_THAN"
          • "LESS_THAN"
          • "NOT_EQUAL_TO"

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • CalculatedAttributeName — (String)

        The unique name of the calculated attribute.

      • DisplayName — (String)

        The display name of the calculated attribute.

      • Description — (String)

        The description of the calculated attribute.

      • CreatedAt — (Date)

        The timestamp of when the calculated attribute definition was created.

      • LastUpdatedAt — (Date)

        The timestamp of when the calculated attribute definition was most recently edited.

      • Statistic — (String)

        The aggregation operation to perform for the calculated attribute.

        Possible values include:
        • "FIRST_OCCURRENCE"
        • "LAST_OCCURRENCE"
        • "COUNT"
        • "SUM"
        • "MINIMUM"
        • "MAXIMUM"
        • "AVERAGE"
        • "MAX_OCCURRENCE"
      • Conditions — (map)

        The conditions including range, object count, and threshold for the calculated attribute.

        • Range — (map)

          The relative time period over which data is included in the aggregation.

          • Valuerequired — (Integer)

            The amount of time of the specified unit.

          • Unitrequired — (String)

            The unit of time.

            Possible values include:
            • "DAYS"
        • ObjectCount — (Integer)

          The number of profile objects used for the calculated attribute.

        • Threshold — (map)

          The threshold for the calculated attribute.

          • Valuerequired — (String)

            The value of the threshold.

          • Operatorrequired — (String)

            The operator of the threshold.

            Possible values include:
            • "EQUAL_TO"
            • "GREATER_THAN"
            • "LESS_THAN"
            • "NOT_EQUAL_TO"
      • AttributeDetails — (map)

        The mathematical expression and a list of attribute items specified in that expression.

        • Attributesrequired — (Array<map>)

          A list of attribute items specified in the mathematical expression.

          • Namerequired — (String)

            The name of an attribute defined in a profile object type.

        • Expressionrequired — (String)

          Mathematical expression that is performed on attribute items provided in the attribute list. Each element in the expression should follow the structure of \"{ObjectTypeName.AttributeName}\".

      • 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.

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.

Use this API or CreateDomain to enable identity resolution: set Matching to true.

To prevent cross-service impersonation when you call this API, see Cross-service confused deputy prevention for sample policies that you should apply.

To add or remove tags on an existing Domain, see TagResource/UntagResource.

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 */
    AutoMerging: {
      Enabled: true || false, /* required */
      ConflictResolution: {
        ConflictResolvingModel: RECENCY | SOURCE, /* required */
        SourceName: 'STRING_VALUE'
      },
      Consolidation: {
        MatchingAttributesList: [ /* required */
          [
            'STRING_VALUE',
            /* more items */
          ],
          /* more items */
        ]
      },
      MinAllowedConfidenceScoreForMerging: 'NUMBER_VALUE'
    },
    ExportingConfig: {
      S3Exporting: {
        S3BucketName: 'STRING_VALUE', /* required */
        S3KeyName: 'STRING_VALUE'
      }
    },
    JobSchedule: {
      DayOfTheWeek: SUNDAY | MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY, /* required */
      Time: 'STRING_VALUE' /* required */
    }
  },
  RuleBasedMatching: {
    Enabled: true || false, /* required */
    AttributeTypesSelector: {
      AttributeMatchingModel: ONE_TO_ONE | MANY_TO_MANY, /* required */
      Address: [
        'STRING_VALUE',
        /* more items */
      ],
      EmailAddress: [
        'STRING_VALUE',
        /* more items */
      ],
      PhoneNumber: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    ConflictResolution: {
      ConflictResolvingModel: RECENCY | SOURCE, /* required */
      SourceName: 'STRING_VALUE'
    },
    ExportingConfig: {
      S3Exporting: {
        S3BucketName: 'STRING_VALUE', /* required */
        S3KeyName: 'STRING_VALUE'
      }
    },
    MatchingRules: [
      {
        Rule: [ /* required */
          'STRING_VALUE',
          /* more items */
        ]
      },
      /* more items */
    ],
    MaxAllowedRuleLevelForMatching: 'NUMBER_VALUE',
    MaxAllowedRuleLevelForMerging: 'NUMBER_VALUE'
  },
  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. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains.

      After the Identity Resolution Job completes, use the GetMatches API to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from S3.

      • Enabledrequired — (Boolean)

        The flag that enables the matching process of duplicate profiles.

      • JobSchedule — (map)

        The day and time when do you want to start the Identity Resolution Job every week.

        • DayOfTheWeekrequired — (String)

          The day when the Identity Resolution Job should run every week.

          Possible values include:
          • "SUNDAY"
          • "MONDAY"
          • "TUESDAY"
          • "WEDNESDAY"
          • "THURSDAY"
          • "FRIDAY"
          • "SATURDAY"
        • Timerequired — (String)

          The time when the Identity Resolution Job should run every week.

      • AutoMerging — (map)

        Configuration information about the auto-merging process.

        • Enabledrequired — (Boolean)

          The flag that enables the auto-merging of duplicate profiles.

        • Consolidation — (map)

          A list of matching attributes that represent matching criteria. If two profiles meet at least one of the requirements in the matching attributes list, they will be merged.

          • MatchingAttributesListrequired — (Array<Array<String>>)

            A list of matching criteria.

        • ConflictResolution — (map)

          How the auto-merging process should resolve conflicts between different profiles. For example, if Profile A and Profile B have the same FirstName and LastName (and that is the matching criteria), which EmailAddress should be used?

          • ConflictResolvingModelrequired — (String)

            How the auto-merging process should resolve conflicts between different profiles.

            • RECENCY: Uses the data that was most recently updated.

            • SOURCE: Uses the data from a specific source. For example, if a company has been aquired or two departments have merged, data from the specified source is used. If two duplicate profiles are from the same source, then RECENCY is used again.

            Possible values include:
            • "RECENCY"
            • "SOURCE"
          • SourceName — (String)

            The ObjectType name that is used to resolve profile merging conflicts when choosing SOURCE as the ConflictResolvingModel.

        • MinAllowedConfidenceScoreForMerging — (Float)

          A number between 0 and 1 that represents the minimum confidence score required for profiles within a matching group to be merged during the auto-merge process. A higher score means higher similarity required to merge profiles.

      • ExportingConfig — (map)

        Configuration information for exporting Identity Resolution results, for example, to an S3 bucket.

        • S3Exporting — (map)

          The S3 location where Identity Resolution Jobs write result files.

          • S3BucketNamerequired — (String)

            The name of the S3 bucket where Identity Resolution Jobs write result files.

          • S3KeyName — (String)

            The S3 key name of the location where Identity Resolution Jobs write result files.

    • RuleBasedMatching — (map)

      The process of matching duplicate profiles using the rule-Based matching. If RuleBasedMatching = true, Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration in the RuleBasedMatchingRequest. You can use the ListRuleBasedMatches and GetSimilarProfiles API to return and review the results. Also, if you have configured ExportingConfig in the RuleBasedMatchingRequest, you can download the results from S3.

      • Enabledrequired — (Boolean)

        The flag that enables the rule-based matching process of duplicate profiles.

      • MatchingRules — (Array<map>)

        Configures how the rule-based matching process should match profiles. You can have up to 15 MatchingRule in the MatchingRules.

        • Rulerequired — (Array<String>)

          A single rule level of the MatchRules. Configures how the rule-based matching process should match profiles.

      • MaxAllowedRuleLevelForMerging — (Integer)

        MatchingRule

      • MaxAllowedRuleLevelForMatching — (Integer)

        Indicates the maximum allowed rule level.

      • AttributeTypesSelector — (map)

        Configures information about the AttributeTypesSelector where the rule-based identity resolution uses to match profiles.

        • AttributeMatchingModelrequired — (String)

          Configures the AttributeMatchingModel, you can either choose ONE_TO_ONE or MANY_TO_MANY.

          Possible values include:
          • "ONE_TO_ONE"
          • "MANY_TO_MANY"
        • Address — (Array<String>)

          The Address type. You can choose from Address, BusinessAddress, MaillingAddress, and ShippingAddress.

          You only can use the Address type in the MatchingRule. For example, if you want to match profile based on BusinessAddress.City or MaillingAddress.City, you need to choose the BusinessAddress and the MaillingAddress to represent the Address type and specify the Address.City on the matching rule.

        • PhoneNumber — (Array<String>)

          The PhoneNumber type. You can choose from PhoneNumber, HomePhoneNumber, and MobilePhoneNumber.

          You only can use the PhoneNumber type in the MatchingRule. For example, if you want to match a profile based on Phone or HomePhone, you need to choose the Phone and the HomePhone to represent the PhoneNumber type and only specify the PhoneNumber on the matching rule.

        • EmailAddress — (Array<String>)

          The Email type. You can choose from EmailAddress, BusinessEmailAddress and PersonalEmailAddress.

          You only can use the EmailAddress type in the MatchingRule. For example, if you want to match profile based on PersonalEmailAddress or BusinessEmailAddress, you need to choose the PersonalEmailAddress and the BusinessEmailAddress to represent the EmailAddress type and only specify the EmailAddress on the matching rule.

      • ConflictResolution — (map)

        How the auto-merging process should resolve conflicts between different profiles.

        • ConflictResolvingModelrequired — (String)

          How the auto-merging process should resolve conflicts between different profiles.

          • RECENCY: Uses the data that was most recently updated.

          • SOURCE: Uses the data from a specific source. For example, if a company has been aquired or two departments have merged, data from the specified source is used. If two duplicate profiles are from the same source, then RECENCY is used again.

          Possible values include:
          • "RECENCY"
          • "SOURCE"
        • SourceName — (String)

          The ObjectType name that is used to resolve profile merging conflicts when choosing SOURCE as the ConflictResolvingModel.

      • ExportingConfig — (map)

        Configuration information about the S3 bucket where Identity Resolution Jobs writes result files.

        Note: You need to give Customer Profiles service principal write permission to your S3 bucket. Otherwise, you'll get an exception in the API response. For an example policy, see Amazon Connect Customer Profiles cross-service confused deputy prevention.
        • S3Exporting — (map)

          The S3 location where Identity Resolution Jobs write result files.

          • S3BucketNamerequired — (String)

            The name of the S3 bucket where Identity Resolution Jobs write result files.

          • S3KeyName — (String)

            The S3 key name of the location where Identity Resolution Jobs write result files.

    • 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. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains.

        After the Identity Resolution Job completes, use the GetMatches API to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from S3.

        • Enabled — (Boolean)

          The flag that enables the matching process of duplicate profiles.

        • JobSchedule — (map)

          The day and time when do you want to start the Identity Resolution Job every week.

          • DayOfTheWeekrequired — (String)

            The day when the Identity Resolution Job should run every week.

            Possible values include:
            • "SUNDAY"
            • "MONDAY"
            • "TUESDAY"
            • "WEDNESDAY"
            • "THURSDAY"
            • "FRIDAY"
            • "SATURDAY"
          • Timerequired — (String)

            The time when the Identity Resolution Job should run every week.

        • AutoMerging — (map)

          Configuration information about the auto-merging process.

          • Enabledrequired — (Boolean)

            The flag that enables the auto-merging of duplicate profiles.

          • Consolidation — (map)

            A list of matching attributes that represent matching criteria. If two profiles meet at least one of the requirements in the matching attributes list, they will be merged.

            • MatchingAttributesListrequired — (Array<Array<String>>)

              A list of matching criteria.

          • ConflictResolution — (map)

            How the auto-merging process should resolve conflicts between different profiles. For example, if Profile A and Profile B have the same FirstName and LastName (and that is the matching criteria), which EmailAddress should be used?

            • ConflictResolvingModelrequired — (String)

              How the auto-merging process should resolve conflicts between different profiles.

              • RECENCY: Uses the data that was most recently updated.

              • SOURCE: Uses the data from a specific source. For example, if a company has been aquired or two departments have merged, data from the specified source is used. If two duplicate profiles are from the same source, then RECENCY is used again.

              Possible values include:
              • "RECENCY"
              • "SOURCE"
            • SourceName — (String)

              The ObjectType name that is used to resolve profile merging conflicts when choosing SOURCE as the ConflictResolvingModel.

          • MinAllowedConfidenceScoreForMerging — (Float)

            A number between 0 and 1 that represents the minimum confidence score required for profiles within a matching group to be merged during the auto-merge process. A higher score means higher similarity required to merge profiles.

        • ExportingConfig — (map)

          Configuration information for exporting Identity Resolution results, for example, to an S3 bucket.

          • S3Exporting — (map)

            The S3 location where Identity Resolution Jobs write result files.

            • S3BucketNamerequired — (String)

              The name of the S3 bucket where Identity Resolution Jobs write result files.

            • S3KeyName — (String)

              The S3 key name of the location where Identity Resolution Jobs write result files.

      • RuleBasedMatching — (map)

        The process of matching duplicate profiles using the rule-Based matching. If RuleBasedMatching = true, Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration in the RuleBasedMatchingRequest. You can use the ListRuleBasedMatches and GetSimilarProfiles API to return and review the results. Also, if you have configured ExportingConfig in the RuleBasedMatchingRequest, you can download the results from S3.

        • Enabled — (Boolean)

          The flag that enables the rule-based matching process of duplicate profiles.

        • MatchingRules — (Array<map>)

          Configures how the rule-based matching process should match profiles. You can have up to 15 MatchingRule in the MatchingRules.

          • Rulerequired — (Array<String>)

            A single rule level of the MatchRules. Configures how the rule-based matching process should match profiles.

        • Status — (String)

          PENDING

          • The first status after configuration a rule-based matching rule. If it is an existing domain, the rule-based Identity Resolution waits one hour before creating the matching rule. If it is a new domain, the system will skip the PENDING stage.

          IN_PROGRESS

          • The system is creating the rule-based matching rule. Under this status, the system is evaluating the existing data and you can no longer change the Rule-based matching configuration.

          ACTIVE

          • The rule is ready to use. You can change the rule a day after the status is in ACTIVE.

          Possible values include:
          • "PENDING"
          • "IN_PROGRESS"
          • "ACTIVE"
        • MaxAllowedRuleLevelForMerging — (Integer)

          MatchingRule

        • MaxAllowedRuleLevelForMatching — (Integer)

          Indicates the maximum allowed rule level.

        • AttributeTypesSelector — (map)

          Configures information about the AttributeTypesSelector where the rule-based identity resolution uses to match profiles.

          • AttributeMatchingModelrequired — (String)

            Configures the AttributeMatchingModel, you can either choose ONE_TO_ONE or MANY_TO_MANY.

            Possible values include:
            • "ONE_TO_ONE"
            • "MANY_TO_MANY"
          • Address — (Array<String>)

            The Address type. You can choose from Address, BusinessAddress, MaillingAddress, and ShippingAddress.

            You only can use the Address type in the MatchingRule. For example, if you want to match profile based on BusinessAddress.City or MaillingAddress.City, you need to choose the BusinessAddress and the MaillingAddress to represent the Address type and specify the Address.City on the matching rule.

          • PhoneNumber — (Array<String>)

            The PhoneNumber type. You can choose from PhoneNumber, HomePhoneNumber, and MobilePhoneNumber.

            You only can use the PhoneNumber type in the MatchingRule. For example, if you want to match a profile based on Phone or HomePhone, you need to choose the Phone and the HomePhone to represent the PhoneNumber type and only specify the PhoneNumber on the matching rule.

          • EmailAddress — (Array<String>)

            The Email type. You can choose from EmailAddress, BusinessEmailAddress and PersonalEmailAddress.

            You only can use the EmailAddress type in the MatchingRule. For example, if you want to match profile based on PersonalEmailAddress or BusinessEmailAddress, you need to choose the PersonalEmailAddress and the BusinessEmailAddress to represent the EmailAddress type and only specify the EmailAddress on the matching rule.

        • ConflictResolution — (map)

          How the auto-merging process should resolve conflicts between different profiles.

          • ConflictResolvingModelrequired — (String)

            How the auto-merging process should resolve conflicts between different profiles.

            • RECENCY: Uses the data that was most recently updated.

            • SOURCE: Uses the data from a specific source. For example, if a company has been aquired or two departments have merged, data from the specified source is used. If two duplicate profiles are from the same source, then RECENCY is used again.

            Possible values include:
            • "RECENCY"
            • "SOURCE"
          • SourceName — (String)

            The ObjectType name that is used to resolve profile merging conflicts when choosing SOURCE as the ConflictResolvingModel.

        • ExportingConfig — (map)

          Configuration information about the S3 bucket where Identity Resolution Jobs writes result files.

          Note: You need to give Customer Profiles service principal write permission to your S3 bucket. Otherwise, you'll get an exception in the API response. For an example policy, see Amazon Connect Customer Profiles cross-service confused deputy prevention.
          • S3Exporting — (map)

            The S3 location where Identity Resolution Jobs write result files.

            • S3BucketNamerequired — (String)

              The name of the S3 bucket where Identity Resolution Jobs write result files.

            • S3KeyName — (String)

              The S3 key name of the location where Identity Resolution Jobs write result files.

      • 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,
  GenderString: 'STRING_VALUE',
  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,
  PartyTypeString: 'STRING_VALUE',
  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.

    • PartyTypeString — (String)

      An alternative to PartyType which accepts any string as input.

    • GenderString — (String)

      An alternative to Gender which accepts any string as input.

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.