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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#data_store ⇒ Types::DataStoreRequest

Set to true to enabled data store for this domain.

Returns:



9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 9951

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

#dead_letter_queue_url ⇒ String

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

Returns:

  • (String) 


9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 9951

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

#default_encryption_key ⇒ String

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

Returns:

  • (String) 


9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 9951

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

#default_expiration_days ⇒ Integer

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

Returns:

  • (Integer) 


9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 9951

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

#domain_name ⇒ String

The unique name of the domain.

Returns:

  • (String) 


9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 9951

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

#matching ⇒ Types::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.

Returns:



9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 9951

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

#rule_based_matching ⇒ Types::RuleBasedMatchingRequest

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.

Returns:



9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 9951

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

#tags ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 9951

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