Class: Aws::CustomerProfiles::Types::UpdateDomainRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb

Overview

Note:

When making an API call, you may pass UpdateDomainRequest data as a hash:

{
  domain_name: "name", # required
  default_expiration_days: 1,
  default_encryption_key: "encryptionKey",
  dead_letter_queue_url: "sqsQueueUrl",
  matching: {
    enabled: false, # required
    job_schedule: {
      day_of_the_week: "SUNDAY", # required, accepts SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY
      time: "JobScheduleTime", # required
    },
    auto_merging: {
      enabled: false, # required
      consolidation: {
        matching_attributes_list: [ # required
          ["string1To255"],
        ],
      },
      conflict_resolution: {
        conflict_resolving_model: "RECENCY", # required, accepts RECENCY, SOURCE
        source_name: "string1To255",
      },
    },
    exporting_config: {
      s3_exporting: {
        s3_bucket_name: "s3BucketName", # required
        s3_key_name: "s3KeyNameCustomerOutputConfig",
      },
    },
  },
  tags: {
    "TagKey" => "TagValue",
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#dead_letter_queue_urlString

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.

Returns:

  • (String)


4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 4964

class UpdateDomainRequest < Struct.new(
  :domain_name,
  :default_expiration_days,
  :default_encryption_key,
  :dead_letter_queue_url,
  :matching,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#default_encryption_keyString

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.

Returns:

  • (String)


4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 4964

class UpdateDomainRequest < Struct.new(
  :domain_name,
  :default_expiration_days,
  :default_encryption_key,
  :dead_letter_queue_url,
  :matching,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#default_expiration_daysInteger

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

Returns:

  • (Integer)


4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 4964

class UpdateDomainRequest < Struct.new(
  :domain_name,
  :default_expiration_days,
  :default_encryption_key,
  :dead_letter_queue_url,
  :matching,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#domain_nameString

The unique name of the domain.

Returns:

  • (String)


4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 4964

class UpdateDomainRequest < Struct.new(
  :domain_name,
  :default_expiration_days,
  :default_encryption_key,
  :dead_letter_queue_url,
  :matching,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#matchingTypes::MatchingRequest

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.



4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 4964

class UpdateDomainRequest < Struct.new(
  :domain_name,
  :default_expiration_days,
  :default_encryption_key,
  :dead_letter_queue_url,
  :matching,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<String,String>

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

Returns:

  • (Hash<String,String>)


4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 4964

class UpdateDomainRequest < Struct.new(
  :domain_name,
  :default_expiration_days,
  :default_encryption_key,
  :dead_letter_queue_url,
  :matching,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end