Class: AWS.CustomerProfiles

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.

    • Attributes — required — (Array<map>)

      A list of attribute items specified in the mathematical expression.

      • Name — required — (String)

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

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

      • Value — required — (Integer)

        The amount of time of the specified unit.

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

      • Value — required — (String)

        The value of the threshold.

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

      • Attributes — required — (Array<map>)

        A list of attribute items specified in the mathematical expression.

        • Name — required — (String)

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

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

        • Value — required — (Integer)

          The amount of time of the specified unit.

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

        • Value — required — (String)

          The value of the threshold.

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

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.

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

      • DayOfTheWeek — required — (String)

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

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

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

    • AutoMerging — (map)

      Configuration information about the auto-merging process.

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

        • MatchingAttributesList — required — (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?

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

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

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

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

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

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

        • DayOfTheWeek — required — (String)

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

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

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

      • AutoMerging — (map)

        Configuration information about the auto-merging process.

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

          • MatchingAttributesList — required — (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?

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

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

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

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

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

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

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.

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.

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

        • FlowName — required — (String)

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

        • KmsArn — required — (String)

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

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

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

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

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

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

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

              • Object — required — (String)

                The object specified in the ServiceNow flow source.

            • Zendesk — (map)

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

              • Object — required — (String)

                The object specified in the Zendesk flow source.

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

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

          • TaskType — required — (String)

            Specifies the particular task implementation that Amazon AppFlow performs.

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

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

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

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

        • StartTime — required — (Date)

          Start time of batch to split ingestion.

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

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)

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

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

    • MatchingAttributesList — required — (Array<Array<String>>)

      A list of matching criteria.

  • ConflictResolution — (map)

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

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

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.

        • Value — required — (Integer)

          The amount of time of the specified unit.

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

        • Value — required — (String)

          The value of the threshold.

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

      • Attributes — required — (Array<map>)

        A list of attribute items specified in the mathematical expression.

        • Name — required — (String)

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

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

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.

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.

        • DayOfTheWeek — required — (String)

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

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

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

      • AutoMerging — (map)

        Configuration information about the auto-merging process.

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

          • MatchingAttributesList — required — (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?

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

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

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

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

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

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

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.

      • Uri — required — (String)

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

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

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.

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

        • MatchingAttributesList — required — (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?

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

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.

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.

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.

    • MaxAvailableProfileObjectCount — (Integer)

      The amount of provisioned profile object max count available.

    • MaxProfileObjectCount — (Integer)

      The amount of profile object max count assigned to the object type.

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

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.

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.

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.

        • SourceConnectorType — required — (String)

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

          Possible values include:
          • "Salesforce"
          • "Marketo"
          • "Zendesk"
          • "Servicenow"
          • "S3"
        • ConnectorProfileName — required — (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.

        • RecordsProcessed — required — (Integer)

          Number of records processed in APPFLOW_INTEGRATION workflow.

        • StepsCompleted — required — (Integer)

          Total steps completed in APPFLOW_INTEGRATION workflow.

        • TotalSteps — required — (Integer)

          Total steps in APPFLOW_INTEGRATION workflow.

Returns:

• (AWS.Request) —

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

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.

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

        • Status — required — (String)

          Workflow step status for APPFLOW_INTEGRATION workflow.

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

          Message indicating execution of workflow step for APPFLOW_INTEGRATION workflow.

        • RecordsProcessed — required — (Integer)

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

        • BatchRecordsStartTime — required — (String)

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

        • BatchRecordsEndTime — required — (String)

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

        • CreatedAt — required — (Date)

          Creation timestamp of workflow step for APPFLOW_INTEGRATION workflow.

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

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.

      • DomainName — required — (String)

        The unique name of the domain.

      • Uri — required — (String)

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

      • ObjectTypeName — (String)

        The name of the profile object type.

      • CreatedAt — required — (Date)

        The timestamp of when the domain was created.

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

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.

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.

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.

      • DomainName — required — (String)

        The unique name of the domain.

      • CreatedAt — required — (Date)

        The timestamp of when the domain was created.

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

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.

      • DomainName — required — (String)

        The unique name of the domain.

      • EventStreamName — required — (String)

        The name of the event stream.

      • EventStreamArn — required — (String)

        A unique identifier for the event stream.

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

        • Uri — required — (String)

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

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

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.

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.

      • DomainName — required — (String)

        The unique name of the domain.

      • Uri — required — (String)

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

      • ObjectTypeName — (String)

        The name of the profile object type.

      • CreatedAt — required — (Date)

        The timestamp of when the domain was created.

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

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.

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

    • Values — required — (Array<String>)

      A list of key values.