AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Connect Customer Profiles UpdateDomain API operation.

Syntax

Update-CPFDomain
-DomainName <String>
-AttributeTypesSelector_Address <String[]>
-AttributeTypesSelector_AttributeMatchingModel <AttributeMatchingModel>
-ConflictResolution_ConflictResolvingModel <ConflictResolvingModel>
-RuleBasedMatching_ConflictResolution_ConflictResolvingModel <ConflictResolvingModel>
-JobSchedule_DayOfTheWeek <JobScheduleDayOfTheWeek>
-DeadLetterQueueUrl <String>
-DefaultEncryptionKey <String>
-DefaultExpirationDay <Int32>
-AttributeTypesSelector_EmailAddress <String[]>
-AutoMerging_Enabled <Boolean>
-Matching_Enabled <Boolean>
-RuleBasedMatching_Enabled <Boolean>
-Consolidation_MatchingAttributesList <String[][]>
-RuleBasedMatching_MatchingRule <MatchingRule[]>
-RuleBasedMatching_MaxAllowedRuleLevelForMatching <Int32>
-RuleBasedMatching_MaxAllowedRuleLevelForMerging <Int32>
-AutoMerging_MinAllowedConfidenceScoreForMerging <Double>
-AttributeTypesSelector_PhoneNumber <String[]>
-S3Exporting_S3BucketName <String>
-RuleBasedMatching_ExportingConfig_S3Exporting_S3BucketName <String>
-S3Exporting_S3KeyName <String>
-RuleBasedMatching_ExportingConfig_S3Exporting_S3KeyName <String>
-ConflictResolution_SourceName <String>
-RuleBasedMatching_ConflictResolution_SourceName <String>
-Tag <Hashtable>
-JobSchedule_Time <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonCustomerProfilesConfig>

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 CreateDomain to enable identity resolution: set Matching to true. To prevent cross-service impersonation when you call this API, see Cross-service confused deputy prevention for sample policies that you should apply. To add or remove tags on an existing Domain, see TagResource/UntagResource.

Parameters

-AttributeTypesSelector_Address <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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRuleBasedMatching_AttributeTypesSelector_Address
-AttributeTypesSelector_AttributeMatchingModel <AttributeMatchingModel>
Configures the AttributeMatchingModel, you can either choose ONE_TO_ONE or MANY_TO_MANY.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRuleBasedMatching_AttributeTypesSelector_AttributeMatchingModel
-AttributeTypesSelector_EmailAddress <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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRuleBasedMatching_AttributeTypesSelector_EmailAddress
-AttributeTypesSelector_PhoneNumber <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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRuleBasedMatching_AttributeTypesSelector_PhoneNumber
-AutoMerging_Enabled <Boolean>
The flag that enables the auto-merging of duplicate profiles.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMatching_AutoMerging_Enabled
-AutoMerging_MinAllowedConfidenceScoreForMerging <Double>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMatching_AutoMerging_MinAllowedConfidenceScoreForMerging
-ClientConfig <AmazonCustomerProfilesConfig>
Amazon.PowerShell.Cmdlets.CPF.AmazonCustomerProfilesClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConflictResolution_ConflictResolvingModel <ConflictResolvingModel>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMatching_AutoMerging_ConflictResolution_ConflictResolvingModel
-ConflictResolution_SourceName <String>
The ObjectType name that is used to resolve profile merging conflicts when choosing SOURCE as the ConflictResolvingModel.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMatching_AutoMerging_ConflictResolution_SourceName
-Consolidation_MatchingAttributesList <String[][]>
A list of matching criteria.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMatching_AutoMerging_Consolidation_MatchingAttributesList
-DeadLetterQueueUrl <String>
The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications. If specified as an empty string, it will clear any existing value. You must set up a policy on the DeadLetterQueue for the SendMessage operation to enable Amazon Connect Customer Profiles to send messages to the DeadLetterQueue.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefaultEncryptionKey <String>
The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage. If specified as an empty string, it will clear any existing value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DefaultExpirationDay <Int32>
The default number of days until the data within the domain expires.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefaultExpirationDays
-DomainName <String>
The unique name of the domain.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-JobSchedule_DayOfTheWeek <JobScheduleDayOfTheWeek>
The day when the Identity Resolution Job should run every week.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMatching_JobSchedule_DayOfTheWeek
-JobSchedule_Time <String>
The time when the Identity Resolution Job should run every week.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMatching_JobSchedule_Time
-Matching_Enabled <Boolean>
The flag that enables the matching process of duplicate profiles.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the DomainName parameter. The -PassThru parameter is deprecated, use -Select '^DomainName' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RuleBasedMatching_ConflictResolution_ConflictResolvingModel <ConflictResolvingModel>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RuleBasedMatching_ConflictResolution_SourceName <String>
The ObjectType name that is used to resolve profile merging conflicts when choosing SOURCE as the ConflictResolvingModel.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RuleBasedMatching_Enabled <Boolean>
The flag that enables the rule-based matching process of duplicate profiles.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RuleBasedMatching_ExportingConfig_S3Exporting_S3BucketName <String>
The name of the S3 bucket where Identity Resolution Jobs write result files.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RuleBasedMatching_ExportingConfig_S3Exporting_S3KeyName <String>
The S3 key name of the location where Identity Resolution Jobs write result files.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RuleBasedMatching_MatchingRule <MatchingRule[]>
Configures how the rule-based matching process should match profiles. You can have up to 15 MatchingRule in the MatchingRules.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRuleBasedMatching_MatchingRules
-RuleBasedMatching_MaxAllowedRuleLevelForMatching <Int32>
Indicates the maximum allowed rule level.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RuleBasedMatching_MaxAllowedRuleLevelForMerging <Int32>
MatchingRule
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3Exporting_S3BucketName <String>
The name of the S3 bucket where Identity Resolution Jobs write result files.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMatching_ExportingConfig_S3Exporting_S3BucketName
-S3Exporting_S3KeyName <String>
The S3 key name of the location where Identity Resolution Jobs write result files.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMatching_ExportingConfig_S3Exporting_S3KeyName
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CustomerProfiles.Model.UpdateDomainResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.UpdateDomainResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Hashtable>
The tags used to organize, track, or control access for this resource.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.CustomerProfiles.Model.UpdateDomainResponse
This cmdlet returns an Amazon.CustomerProfiles.Model.UpdateDomainResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z