Update Domain

customerprofiles_update_domain

R Documentation

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

Description

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

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

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

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

To add or remove tags on an existing Domain, see tag_resource/untag_resource.

Usage

customerprofiles_update_domain(DomainName, DefaultExpirationDays,
  DefaultEncryptionKey, DeadLetterQueueUrl, Matching, RuleBasedMatching,
  Tags)

Arguments

DomainName

[required] The unique name of the domain.

DefaultExpirationDays

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

DefaultEncryptionKey

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

DeadLetterQueueUrl

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

Matching

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 get_matches API to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from S3.

RuleBasedMatching

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 list_rule_based_matches and get_similar_profiles API to return and review the results. Also, if you have configured ExportingConfig in the RuleBasedMatchingRequest, you can download the results from S3.

Tags

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

Value

A list with the following syntax:

list(
  DomainName = "string",
  DefaultExpirationDays = 123,
  DefaultEncryptionKey = "string",
  DeadLetterQueueUrl = "string",
  Matching = list(
    Enabled = TRUE|FALSE,
    JobSchedule = list(
      DayOfTheWeek = "SUNDAY"|"MONDAY"|"TUESDAY"|"WEDNESDAY"|"THURSDAY"|"FRIDAY"|"SATURDAY",
      Time = "string"
    ),
    AutoMerging = list(
      Enabled = TRUE|FALSE,
      Consolidation = list(
        MatchingAttributesList = list(
          list(
            "string"
          )
        )
      ),
      ConflictResolution = list(
        ConflictResolvingModel = "RECENCY"|"SOURCE",
        SourceName = "string"
      ),
      MinAllowedConfidenceScoreForMerging = 123.0
    ),
    ExportingConfig = list(
      S3Exporting = list(
        S3BucketName = "string",
        S3KeyName = "string"
      )
    )
  ),
  RuleBasedMatching = list(
    Enabled = TRUE|FALSE,
    MatchingRules = list(
      list(
        Rule = list(
          "string"
        )
      )
    ),
    Status = "PENDING"|"IN_PROGRESS"|"ACTIVE",
    MaxAllowedRuleLevelForMerging = 123,
    MaxAllowedRuleLevelForMatching = 123,
    AttributeTypesSelector = list(
      AttributeMatchingModel = "ONE_TO_ONE"|"MANY_TO_MANY",
      Address = list(
        "string"
      ),
      PhoneNumber = list(
        "string"
      ),
      EmailAddress = list(
        "string"
      )
    ),
    ConflictResolution = list(
      ConflictResolvingModel = "RECENCY"|"SOURCE",
      SourceName = "string"
    ),
    ExportingConfig = list(
      S3Exporting = list(
        S3BucketName = "string",
        S3KeyName = "string"
      )
    )
  ),
  CreatedAt = as.POSIXct(
    "2015-01-01"
  ),
  LastUpdatedAt = as.POSIXct(
    "2015-01-01"
  ),
  Tags = list(
    "string"
  )
)

Request syntax

svc$update_domain(
  DomainName = "string",
  DefaultExpirationDays = 123,
  DefaultEncryptionKey = "string",
  DeadLetterQueueUrl = "string",
  Matching = list(
    Enabled = TRUE|FALSE,
    JobSchedule = list(
      DayOfTheWeek = "SUNDAY"|"MONDAY"|"TUESDAY"|"WEDNESDAY"|"THURSDAY"|"FRIDAY"|"SATURDAY",
      Time = "string"
    ),
    AutoMerging = list(
      Enabled = TRUE|FALSE,
      Consolidation = list(
        MatchingAttributesList = list(
          list(
            "string"
          )
        )
      ),
      ConflictResolution = list(
        ConflictResolvingModel = "RECENCY"|"SOURCE",
        SourceName = "string"
      ),
      MinAllowedConfidenceScoreForMerging = 123.0
    ),
    ExportingConfig = list(
      S3Exporting = list(
        S3BucketName = "string",
        S3KeyName = "string"
      )
    )
  ),
  RuleBasedMatching = list(
    Enabled = TRUE|FALSE,
    MatchingRules = list(
      list(
        Rule = list(
          "string"
        )
      )
    ),
    MaxAllowedRuleLevelForMerging = 123,
    MaxAllowedRuleLevelForMatching = 123,
    AttributeTypesSelector = list(
      AttributeMatchingModel = "ONE_TO_ONE"|"MANY_TO_MANY",
      Address = list(
        "string"
      ),
      PhoneNumber = list(
        "string"
      ),
      EmailAddress = list(
        "string"
      )
    ),
    ConflictResolution = list(
      ConflictResolvingModel = "RECENCY"|"SOURCE",
      SourceName = "string"
    ),
    ExportingConfig = list(
      S3Exporting = list(
        S3BucketName = "string",
        S3KeyName = "string"
      )
    )
  ),
  Tags = list(
    "string"
  )
)