AWS.Tools.CustomerProfiles.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.CustomerProfiles</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.CPF.AddCPFProfileKeyCmdlet"> <summary> Associates a new key value with a specific profile, such as a Contact Record ContactId. <para> A profile object can have a single unique key and any number of additional keys that can be used to identify the profile that it belongs to. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.AddCPFProfileKeyCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.AddCPFProfileKeyCmdlet.KeyName"> <summary> <para> <para>A searchable identifier of a customer profile. The predefined keys you can use include: _account, _profileId, _assetId, _caseId, _orderId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, _salesforceAssetId, _zendeskUserId, _zendeskExternalId, _zendeskTicketId, _serviceNowSystemId, _serviceNowIncidentId, _segmentUserId, _shopifyCustomerId, _shopifyOrderId.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.AddCPFProfileKeyCmdlet.ProfileId"> <summary> <para> <para>The unique identifier of a customer profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.AddCPFProfileKeyCmdlet.Value"> <summary> <para> <para>A list of key values.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.AddCPFProfileKeyCmdlet.Select"> <summary> 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.AddProfileKeyResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.AddProfileKeyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.AddCPFProfileKeyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProfileId parameter. The -PassThru parameter is deprecated, use -Select '^ProfileId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.AddCPFProfileKeyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.AddCPFResourceTagCmdlet"> <summary> Assigns one or more tags (key-value pairs) to the specified Amazon Connect Customer Profiles resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged. <para> Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters. </para><para> You can use the TagResource action with a resource that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag. </para><para> You can associate as many as 50 tags with a resource. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.AddCPFResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the resource that you're adding tags to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.AddCPFResourceTagCmdlet.Tag"> <summary> <para> <para>The tags used to organize, track, or control access for this resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.AddCPFResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CustomerProfiles.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.AddCPFResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.AddCPFResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.FindCPFProfileObjectTypeCmdlet"> <summary> The process of detecting profile object type mapping by using given objects. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.FindCPFProfileObjectTypeCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.FindCPFProfileObjectTypeCmdlet.Object"> <summary> <para> <para>A string that is serialized from a JSON object.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.FindCPFProfileObjectTypeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DetectedProfileObjectTypes'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CustomerProfiles.Model.DetectProfileObjectTypeResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.DetectProfileObjectTypeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.FindCPFProfileObjectTypeCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.GetCPFAccountIntegrationListCmdlet"> <summary> Lists all of the integrations associated to a specific URI in the AWS account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFAccountIntegrationListCmdlet.IncludeHidden"> <summary> <para> <para>Boolean to indicate if hidden integration should be returned. Defaults to <c>False</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFAccountIntegrationListCmdlet.Uri"> <summary> <para> <para>The URI of the S3 bucket or any other type of data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFAccountIntegrationListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of objects returned per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFAccountIntegrationListCmdlet.NextToken"> <summary> <para> <para>The pagination token from the previous ListAccountIntegrations API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFAccountIntegrationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Items'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CustomerProfiles.Model.ListAccountIntegrationsResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.ListAccountIntegrationsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFAccountIntegrationListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Uri parameter. The -PassThru parameter is deprecated, use -Select '^Uri' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.GetCPFAutoMergingPreviewCmdlet"> <summary> Tests the auto-merging settings of your Identity Resolution Job without merging your data. It randomly selects a sample of matching groups from the existing matching results, and applies the automerging settings that you provided. You can then view the number of profiles in the sample, the number of matches, and the number of profiles identified to be merged. This enables you to evaluate the accuracy of the attributes in your matching list. <para> You can't view which profiles are matched and would be merged. </para><important><para> We strongly recommend you use this API to do a dry run of the automerging process before running the Identity Resolution Job. Include <b>at least</b> two matching attributes. If your matching list includes too few attributes (such as only <c>FirstName</c> or only <c>LastName</c>), there may be a large number of matches. This increases the chances of erroneous merges. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFAutoMergingPreviewCmdlet.ConflictResolution_ConflictResolvingModel"> <summary> <para> <para>How the auto-merging process should resolve conflicts between different profiles.</para><ul><li><para><c>RECENCY</c>: Uses the data that was most recently updated.</para></li><li><para><c>SOURCE</c>: 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 <c>RECENCY</c> is used again.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFAutoMergingPreviewCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFAutoMergingPreviewCmdlet.Consolidation_MatchingAttributesList"> <summary> <para> <para>A list of matching criteria.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFAutoMergingPreviewCmdlet.MinAllowedConfidenceScoreForMerging"> <summary> <para> <para>Minimum confidence score required for profiles within a matching group to be merged during the auto-merge process.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFAutoMergingPreviewCmdlet.ConflictResolution_SourceName"> <summary> <para> <para>The <c>ObjectType</c> name that is used to resolve profile merging conflicts when choosing <c>SOURCE</c> as the <c>ConflictResolvingModel</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFAutoMergingPreviewCmdlet.Select"> <summary> 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.GetAutoMergingPreviewResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.GetAutoMergingPreviewResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFAutoMergingPreviewCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.GetCPFCalculatedAttributeDefinitionCmdlet"> <summary> Provides more information on a calculated attribute definition for Customer Profiles. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFCalculatedAttributeDefinitionCmdlet.CalculatedAttributeName"> <summary> <para> <para>The unique name of the calculated attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFCalculatedAttributeDefinitionCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFCalculatedAttributeDefinitionCmdlet.Select"> <summary> 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.GetCalculatedAttributeDefinitionResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.GetCalculatedAttributeDefinitionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFCalculatedAttributeDefinitionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CalculatedAttributeName parameter. The -PassThru parameter is deprecated, use -Select '^CalculatedAttributeName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.GetCPFCalculatedAttributeDefinitionListCmdlet"> <summary> Lists calculated attribute definitions for Customer Profiles </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFCalculatedAttributeDefinitionListCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFCalculatedAttributeDefinitionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of calculated attribute definitions returned per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFCalculatedAttributeDefinitionListCmdlet.NextToken"> <summary> <para> <para>The pagination token from the previous call to ListCalculatedAttributeDefinitions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFCalculatedAttributeDefinitionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Items'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CustomerProfiles.Model.ListCalculatedAttributeDefinitionsResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.ListCalculatedAttributeDefinitionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFCalculatedAttributeDefinitionListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.GetCPFCalculatedAttributeForProfileCmdlet"> <summary> Retrieve a calculated attribute for a customer profile. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFCalculatedAttributeForProfileCmdlet.CalculatedAttributeName"> <summary> <para> <para>The unique name of the calculated attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFCalculatedAttributeForProfileCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFCalculatedAttributeForProfileCmdlet.ProfileId"> <summary> <para> <para>The unique identifier of a customer profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFCalculatedAttributeForProfileCmdlet.Select"> <summary> 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.GetCalculatedAttributeForProfileResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.GetCalculatedAttributeForProfileResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFCalculatedAttributeForProfileCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CalculatedAttributeName parameter. The -PassThru parameter is deprecated, use -Select '^CalculatedAttributeName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.GetCPFCalculatedAttributesForProfileListCmdlet"> <summary> Retrieve a list of calculated attributes for a customer profile. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFCalculatedAttributesForProfileListCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFCalculatedAttributesForProfileListCmdlet.ProfileId"> <summary> <para> <para>The unique identifier of a customer profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFCalculatedAttributesForProfileListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of calculated attributes returned per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFCalculatedAttributesForProfileListCmdlet.NextToken"> <summary> <para> <para>The pagination token from the previous call to ListCalculatedAttributesForProfile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFCalculatedAttributesForProfileListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Items'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CustomerProfiles.Model.ListCalculatedAttributesForProfileResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.ListCalculatedAttributesForProfileResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFCalculatedAttributesForProfileListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProfileId parameter. The -PassThru parameter is deprecated, use -Select '^ProfileId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.GetCPFDomainCmdlet"> <summary> Returns information about a specific domain. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFDomainCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFDomainCmdlet.Select"> <summary> 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.GetDomainResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.GetDomainResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFDomainCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.GetCPFDomainListCmdlet"> <summary> Returns a list of all the domains for an AWS account that have been created. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFDomainListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of objects returned per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFDomainListCmdlet.NextToken"> <summary> <para> <para>The pagination token from the previous ListDomain API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFDomainListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Items'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CustomerProfiles.Model.ListDomainsResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.ListDomainsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.GetCPFEventStreamCmdlet"> <summary> Returns information about the specified event stream in a specific domain. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFEventStreamCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFEventStreamCmdlet.EventStreamName"> <summary> <para> <para>The name of the event stream provided during create operations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFEventStreamCmdlet.Select"> <summary> 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.GetEventStreamResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.GetEventStreamResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFEventStreamCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EventStreamName parameter. The -PassThru parameter is deprecated, use -Select '^EventStreamName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.GetCPFEventStreamListCmdlet"> <summary> Returns a list of all the event streams in a specific domain. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFEventStreamListCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFEventStreamListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of objects returned per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFEventStreamListCmdlet.NextToken"> <summary> <para> <para>Identifies the next page of results to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFEventStreamListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Items'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CustomerProfiles.Model.ListEventStreamsResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.ListEventStreamsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFEventStreamListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.GetCPFGetCalculatedAttributeForProfileCmdlet"> <summary> Fetch the possible attribute values given the attribute name. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFGetCalculatedAttributeForProfileCmdlet.CalculatedAttributeName"> <summary> <para> <para>The unique name of the calculated attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFGetCalculatedAttributeForProfileCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFGetCalculatedAttributeForProfileCmdlet.Range_End"> <summary> <para> <para>The end time of when to include objects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFGetCalculatedAttributeForProfileCmdlet.ProfileId"> <summary> <para> <para>List of unique identifiers for customer profiles to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFGetCalculatedAttributeForProfileCmdlet.Range_Start"> <summary> <para> <para>The start time of when to include objects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFGetCalculatedAttributeForProfileCmdlet.Range_Unit"> <summary> <para> <para>The unit for start and end.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFGetCalculatedAttributeForProfileCmdlet.Select"> <summary> 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.BatchGetCalculatedAttributeForProfileResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.BatchGetCalculatedAttributeForProfileResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFGetCalculatedAttributeForProfileCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CalculatedAttributeName parameter. The -PassThru parameter is deprecated, use -Select '^CalculatedAttributeName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.GetCPFGetProfileCmdlet"> <summary> Get a batch of profiles. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFGetProfileCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFGetProfileCmdlet.ProfileId"> <summary> <para> <para>List of unique identifiers for customer profiles to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFGetProfileCmdlet.Select"> <summary> 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.BatchGetProfileResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.BatchGetProfileResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFGetProfileCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.GetCPFIdentityResolutionJobCmdlet"> <summary> Returns information about an Identity Resolution Job in a specific domain. <para> Identity Resolution Jobs are set up using the Amazon Connect admin console. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/use-identity-resolution.html">Use Identity Resolution to consolidate similar profiles</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFIdentityResolutionJobCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFIdentityResolutionJobCmdlet.JobId"> <summary> <para> <para>The unique identifier of the Identity Resolution Job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFIdentityResolutionJobCmdlet.Select"> <summary> 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.GetIdentityResolutionJobResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.GetIdentityResolutionJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFIdentityResolutionJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobId parameter. The -PassThru parameter is deprecated, use -Select '^JobId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.GetCPFIdentityResolutionJobListCmdlet"> <summary> Lists all of the Identity Resolution Jobs in your domain. The response sorts the list by <c>JobStartTime</c>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFIdentityResolutionJobListCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFIdentityResolutionJobListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFIdentityResolutionJobListCmdlet.NextToken"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFIdentityResolutionJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'IdentityResolutionJobsList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CustomerProfiles.Model.ListIdentityResolutionJobsResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.ListIdentityResolutionJobsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFIdentityResolutionJobListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.GetCPFIntegrationCmdlet"> <summary> Returns an integration for a domain. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFIntegrationCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFIntegrationCmdlet.Uri"> <summary> <para> <para>The URI of the S3 bucket or any other type of data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFIntegrationCmdlet.Select"> <summary> 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.GetIntegrationResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.GetIntegrationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFIntegrationCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.GetCPFIntegrationListCmdlet"> <summary> Lists all of the integrations in your domain. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFIntegrationListCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFIntegrationListCmdlet.IncludeHidden"> <summary> <para> <para>Boolean to indicate if hidden integration should be returned. Defaults to <c>False</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFIntegrationListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of objects returned per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFIntegrationListCmdlet.NextToken"> <summary> <para> <para>The pagination token from the previous ListIntegrations API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFIntegrationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Items'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CustomerProfiles.Model.ListIntegrationsResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.ListIntegrationsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFIntegrationListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.GetCPFMatchCmdlet"> <summary> Before calling this API, use <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_CreateDomain.html">CreateDomain</a> or <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UpdateDomain.html">UpdateDomain</a> to enable identity resolution: set <c>Matching</c> to true. <para> GetMatches returns potentially matching profiles, based on the results of the latest run of a machine learning process. </para><important><para> The process of matching duplicate profiles. If <c>Matching</c> = <c>true</c>, 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. </para><para> After the Identity Resolution Job completes, use the <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html">GetMatches</a> API to return and review the results. Or, if you have configured <c>ExportingConfig</c> in the <c>MatchingRequest</c>, you can download the results from S3. </para></important><para> Amazon Connect uses the following profile attributes to identify matches: </para><ul><li><para> PhoneNumber </para></li><li><para> HomePhoneNumber </para></li><li><para> BusinessPhoneNumber </para></li><li><para> MobilePhoneNumber </para></li><li><para> EmailAddress </para></li><li><para> PersonalEmailAddress </para></li><li><para> BusinessEmailAddress </para></li><li><para> FullName </para></li></ul><para> For example, two or more profiles—with spelling mistakes such as <b>John Doe</b> and <b>Jhn Doe</b>, or different casing email addresses such as <b>JOHN_DOE@ANYCOMPANY.COM</b> and <b>johndoe@anycompany.com</b>, or different phone number formats such as <b>555-010-0000</b> and <b>+1-555-010-0000</b>—can be detected as belonging to the same customer <b>John Doe</b> and merged into a unified profile. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFMatchCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFMatchCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFMatchCmdlet.NextToken"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFMatchCmdlet.Select"> <summary> 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.GetMatchesResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.GetMatchesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFMatchCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.GetCPFObjectTypeAttributeListCmdlet"> <summary> Fetch the possible attribute values given the attribute name. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFObjectTypeAttributeListCmdlet.DomainName"> <summary> <para> <para>The unique identifier of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFObjectTypeAttributeListCmdlet.ObjectTypeName"> <summary> <para> <para>The name of the profile object type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFObjectTypeAttributeListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of objects returned per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFObjectTypeAttributeListCmdlet.NextToken"> <summary> <para> <para>The pagination token from the previous call. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFObjectTypeAttributeListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Items'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CustomerProfiles.Model.ListObjectTypeAttributesResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.ListObjectTypeAttributesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFObjectTypeAttributeListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ObjectTypeName parameter. The -PassThru parameter is deprecated, use -Select '^ObjectTypeName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.GetCPFProfileAttributeValueListCmdlet"> <summary> Fetch the possible attribute values given the attribute name. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFProfileAttributeValueListCmdlet.AttributeName"> <summary> <para> <para>The attribute name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFProfileAttributeValueListCmdlet.DomainName"> <summary> <para> <para>The unique identifier of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFProfileAttributeValueListCmdlet.Select"> <summary> 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.ListProfileAttributeValuesResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.ListProfileAttributeValuesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFProfileAttributeValueListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AttributeName parameter. The -PassThru parameter is deprecated, use -Select '^AttributeName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.GetCPFProfileObjectListCmdlet"> <summary> Returns a list of objects associated with a profile of a given ProfileObjectType. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFProfileObjectListCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFProfileObjectListCmdlet.ObjectFilter_KeyName"> <summary> <para> <para>A searchable identifier of a profile object. The predefined keys you can use to search for <c>_asset</c> include: <c>_assetId</c>, <c>_assetName</c>, and <c>_serialNumber</c>. The predefined keys you can use to search for <c>_case</c> include: <c>_caseId</c>. The predefined keys you can use to search for <c>_order</c> include: <c>_orderId</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFProfileObjectListCmdlet.ObjectTypeName"> <summary> <para> <para>The name of the profile object type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFProfileObjectListCmdlet.ProfileId"> <summary> <para> <para>The unique identifier of a customer profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFProfileObjectListCmdlet.ObjectFilter_Value"> <summary> <para> <para>A list of key values.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFProfileObjectListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of objects returned per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFProfileObjectListCmdlet.NextToken"> <summary> <para> <para>The pagination token from the previous call to ListProfileObjects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFProfileObjectListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Items'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CustomerProfiles.Model.ListProfileObjectsResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.ListProfileObjectsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFProfileObjectListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ObjectTypeName parameter. The -PassThru parameter is deprecated, use -Select '^ObjectTypeName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.GetCPFProfileObjectTypeCmdlet"> <summary> Returns the object types for a specific domain. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFProfileObjectTypeCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFProfileObjectTypeCmdlet.ObjectTypeName"> <summary> <para> <para>The name of the profile object type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFProfileObjectTypeCmdlet.Select"> <summary> 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.GetProfileObjectTypeResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.GetProfileObjectTypeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFProfileObjectTypeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ObjectTypeName parameter. The -PassThru parameter is deprecated, use -Select '^ObjectTypeName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.GetCPFProfileObjectTypeListCmdlet"> <summary> Lists all of the templates available within the service. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFProfileObjectTypeListCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFProfileObjectTypeListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of objects returned per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFProfileObjectTypeListCmdlet.NextToken"> <summary> <para> <para>Identifies the next page of results to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFProfileObjectTypeListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Items'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CustomerProfiles.Model.ListProfileObjectTypesResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.ListProfileObjectTypesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFProfileObjectTypeListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.GetCPFProfileObjectTypeTemplateCmdlet"> <summary> Returns the template information for a specific object type. <para> A template is a predefined ProfileObjectType, such as “Salesforce-Account” or “Salesforce-Contact.” When a user sends a ProfileObject, using the PutProfileObject API, with an ObjectTypeName that matches one of the TemplateIds, it uses the mappings from the template. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFProfileObjectTypeTemplateCmdlet.TemplateId"> <summary> <para> <para>A unique identifier for the object template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFProfileObjectTypeTemplateCmdlet.Select"> <summary> 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.GetProfileObjectTypeTemplateResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.GetProfileObjectTypeTemplateResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFProfileObjectTypeTemplateCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TemplateId parameter. The -PassThru parameter is deprecated, use -Select '^TemplateId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.GetCPFProfileObjectTypeTemplateListCmdlet"> <summary> Lists all of the template information for object types. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFProfileObjectTypeTemplateListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of objects returned per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFProfileObjectTypeTemplateListCmdlet.NextToken"> <summary> <para> <para>The pagination token from the previous ListObjectTypeTemplates API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFProfileObjectTypeTemplateListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Items'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CustomerProfiles.Model.ListProfileObjectTypeTemplatesResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.ListProfileObjectTypeTemplatesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.GetCPFResourceTagCmdlet"> <summary> Displays the tags associated with an Amazon Connect Customer Profiles resource. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the resource for which you want to view tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CustomerProfiles.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.GetCPFRuleBasedMatchListCmdlet"> <summary> Returns a set of <c>MatchIds</c> that belong to the given domain. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFRuleBasedMatchListCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFRuleBasedMatchListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of <c>MatchIds</c> returned per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFRuleBasedMatchListCmdlet.NextToken"> <summary> <para> <para>The pagination token from the previous <c>ListRuleBasedMatches</c> API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFRuleBasedMatchListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MatchIds'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CustomerProfiles.Model.ListRuleBasedMatchesResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.ListRuleBasedMatchesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFRuleBasedMatchListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.GetCPFSegmentDefinitionCmdlet"> <summary> Gets a segment definition from the domain. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFSegmentDefinitionCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFSegmentDefinitionCmdlet.SegmentDefinitionName"> <summary> <para> <para>The unique name of the segment definition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFSegmentDefinitionCmdlet.Select"> <summary> 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.GetSegmentDefinitionResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.GetSegmentDefinitionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFSegmentDefinitionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SegmentDefinitionName parameter. The -PassThru parameter is deprecated, use -Select '^SegmentDefinitionName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.GetCPFSegmentDefinitionListCmdlet"> <summary> Lists all segment definitions under a domain. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFSegmentDefinitionListCmdlet.DomainName"> <summary> <para> <para>The unique identifier of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFSegmentDefinitionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of objects returned per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFSegmentDefinitionListCmdlet.NextToken"> <summary> <para> <para>The pagination token from the previous call. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFSegmentDefinitionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Items'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CustomerProfiles.Model.ListSegmentDefinitionsResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.ListSegmentDefinitionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFSegmentDefinitionListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.GetCPFSegmentEstimateCmdlet"> <summary> Gets the result of a segment estimate query. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFSegmentEstimateCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFSegmentEstimateCmdlet.EstimateId"> <summary> <para> <para>The query Id passed by a previous <c>CreateSegmentEstimate</c> operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFSegmentEstimateCmdlet.Select"> <summary> 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.GetSegmentEstimateResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.GetSegmentEstimateResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFSegmentEstimateCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EstimateId parameter. The -PassThru parameter is deprecated, use -Select '^EstimateId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.GetCPFSegmentMembershipCmdlet"> <summary> Determines if the given profiles are within a segment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFSegmentMembershipCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFSegmentMembershipCmdlet.ProfileId"> <summary> <para> <para>The list of profile IDs to query for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFSegmentMembershipCmdlet.SegmentDefinitionName"> <summary> <para> <para>The Id of the wanted segment. Needs to be a valid, and existing segment Id.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFSegmentMembershipCmdlet.Select"> <summary> 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.GetSegmentMembershipResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.GetSegmentMembershipResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFSegmentMembershipCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SegmentDefinitionName parameter. The -PassThru parameter is deprecated, use -Select '^SegmentDefinitionName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.GetCPFSegmentSnapshotCmdlet"> <summary> Retrieve the latest status of a segment snapshot. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFSegmentSnapshotCmdlet.DomainName"> <summary> <para> <para>The unique identifier of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFSegmentSnapshotCmdlet.SegmentDefinitionName"> <summary> <para> <para>The unique name of the segment definition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFSegmentSnapshotCmdlet.SnapshotId"> <summary> <para> <para>The unique identifier of the segment snapshot.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFSegmentSnapshotCmdlet.Select"> <summary> 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.GetSegmentSnapshotResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.GetSegmentSnapshotResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFSegmentSnapshotCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SnapshotId parameter. The -PassThru parameter is deprecated, use -Select '^SnapshotId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.GetCPFSimilarProfileCmdlet"> <summary> Returns a set of profiles that belong to the same matching group using the <c>matchId</c> or <c>profileId</c>. You can also specify the type of matching that you want for finding similar profiles using either <c>RULE_BASED_MATCHING</c> or <c>ML_BASED_MATCHING</c>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFSimilarProfileCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFSimilarProfileCmdlet.MatchType"> <summary> <para> <para>Specify the type of matching to get similar profiles for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFSimilarProfileCmdlet.SearchKey"> <summary> <para> <para>The string indicating the search key to be used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFSimilarProfileCmdlet.SearchValue"> <summary> <para> <para>The string based on <c>SearchKey</c> to be searched for similar profiles.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFSimilarProfileCmdlet.MaxResult"> <summary> <para> <para>The maximum number of objects returned per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFSimilarProfileCmdlet.NextToken"> <summary> <para> <para>The pagination token from the previous <c>GetSimilarProfiles</c> API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFSimilarProfileCmdlet.Select"> <summary> 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.GetSimilarProfilesResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.GetSimilarProfilesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFSimilarProfileCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.GetCPFWorkflowCmdlet"> <summary> Get details of specified workflow. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFWorkflowCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFWorkflowCmdlet.WorkflowId"> <summary> <para> <para>Unique identifier for the workflow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFWorkflowCmdlet.Select"> <summary> 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.GetWorkflowResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.GetWorkflowResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFWorkflowCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WorkflowId parameter. The -PassThru parameter is deprecated, use -Select '^WorkflowId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.GetCPFWorkflowListCmdlet"> <summary> Query to list all workflows. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFWorkflowListCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFWorkflowListCmdlet.QueryEndDate"> <summary> <para> <para>Retrieve workflows ended after timestamp.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFWorkflowListCmdlet.QueryStartDate"> <summary> <para> <para>Retrieve workflows started after timestamp.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFWorkflowListCmdlet.Status"> <summary> <para> <para>Status of workflow execution.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFWorkflowListCmdlet.WorkflowType"> <summary> <para> <para>The type of workflow. The only supported value is APPFLOW_INTEGRATION.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFWorkflowListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFWorkflowListCmdlet.NextToken"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFWorkflowListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Items'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CustomerProfiles.Model.ListWorkflowsResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.ListWorkflowsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFWorkflowListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.GetCPFWorkflowStepCmdlet"> <summary> Get granular list of steps in workflow. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFWorkflowStepCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFWorkflowStepCmdlet.WorkflowId"> <summary> <para> <para>Unique identifier for the workflow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFWorkflowStepCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFWorkflowStepCmdlet.NextToken"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFWorkflowStepCmdlet.Select"> <summary> 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.GetWorkflowStepsResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.GetWorkflowStepsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.GetCPFWorkflowStepCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WorkflowId parameter. The -PassThru parameter is deprecated, use -Select '^WorkflowId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.MergeCPFProfileCmdlet"> <summary> Runs an AWS Lambda job that does the following: <ol><li><para> All the profileKeys in the <c>ProfileToBeMerged</c> will be moved to the main profile. </para></li><li><para> All the objects in the <c>ProfileToBeMerged</c> will be moved to the main profile. </para></li><li><para> All the <c>ProfileToBeMerged</c> will be deleted at the end. </para></li><li><para> All the profileKeys in the <c>ProfileIdsToBeMerged</c> will be moved to the main profile. </para></li><li><para> Standard fields are merged as follows: </para><ol><li><para> Fields are always "union"-ed if there are no conflicts in standard fields or attributeKeys. </para></li><li><para> When there are conflicting fields: </para><ol><li><para> If no <c>SourceProfileIds</c> entry is specified, the main Profile value is always taken. </para></li><li><para> If a <c>SourceProfileIds</c> entry is specified, the specified profileId is always taken, even if it is a NULL value. </para></li></ol></li></ol></li></ol><para> You can use MergeProfiles together with <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html">GetMatches</a>, which returns potentially matching profiles, or use it with the results of another matching system. After profiles have been merged, they cannot be separated (unmerged). </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.MergeCPFProfileCmdlet.FieldSourceProfileIds_AccountNumber"> <summary> <para> <para>A unique identifier for the account number field to be merged. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.MergeCPFProfileCmdlet.FieldSourceProfileIds_AdditionalInformation"> <summary> <para> <para>A unique identifier for the additional information field to be merged.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.MergeCPFProfileCmdlet.FieldSourceProfileIds_Address"> <summary> <para> <para>A unique identifier for the party type field to be merged.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.MergeCPFProfileCmdlet.FieldSourceProfileIds_Attribute"> <summary> <para> <para>A unique identifier for the attributes field to be merged.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.MergeCPFProfileCmdlet.FieldSourceProfileIds_BillingAddress"> <summary> <para> <para>A unique identifier for the billing type field to be merged.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.MergeCPFProfileCmdlet.FieldSourceProfileIds_BirthDate"> <summary> <para> <para>A unique identifier for the birthdate field to be merged.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.MergeCPFProfileCmdlet.FieldSourceProfileIds_BusinessEmailAddress"> <summary> <para> <para>A unique identifier for the party type field to be merged.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.MergeCPFProfileCmdlet.FieldSourceProfileIds_BusinessName"> <summary> <para> <para>A unique identifier for the business name field to be merged.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.MergeCPFProfileCmdlet.FieldSourceProfileIds_BusinessPhoneNumber"> <summary> <para> <para>A unique identifier for the business phone number field to be merged.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.MergeCPFProfileCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.MergeCPFProfileCmdlet.FieldSourceProfileIds_EmailAddress"> <summary> <para> <para>A unique identifier for the email address field to be merged.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.MergeCPFProfileCmdlet.FieldSourceProfileIds_FirstName"> <summary> <para> <para>A unique identifier for the first name field to be merged.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.MergeCPFProfileCmdlet.FieldSourceProfileIds_Gender"> <summary> <para> <para>A unique identifier for the gender field to be merged.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.MergeCPFProfileCmdlet.FieldSourceProfileIds_HomePhoneNumber"> <summary> <para> <para>A unique identifier for the home phone number field to be merged.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.MergeCPFProfileCmdlet.FieldSourceProfileIds_LastName"> <summary> <para> <para>A unique identifier for the last name field to be merged.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.MergeCPFProfileCmdlet.FieldSourceProfileIds_MailingAddress"> <summary> <para> <para>A unique identifier for the mailing address field to be merged.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.MergeCPFProfileCmdlet.MainProfileId"> <summary> <para> <para>The identifier of the profile to be taken.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.MergeCPFProfileCmdlet.FieldSourceProfileIds_MiddleName"> <summary> <para> <para>A unique identifier for the middle name field to be merged.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.MergeCPFProfileCmdlet.FieldSourceProfileIds_MobilePhoneNumber"> <summary> <para> <para>A unique identifier for the mobile phone number field to be merged.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.MergeCPFProfileCmdlet.FieldSourceProfileIds_PartyType"> <summary> <para> <para>A unique identifier for the party type field to be merged.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.MergeCPFProfileCmdlet.FieldSourceProfileIds_PersonalEmailAddress"> <summary> <para> <para>A unique identifier for the personal email address field to be merged.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.MergeCPFProfileCmdlet.FieldSourceProfileIds_PhoneNumber"> <summary> <para> <para>A unique identifier for the phone number field to be merged.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.MergeCPFProfileCmdlet.ProfileIdsToBeMerged"> <summary> <para> <para>The identifier of the profile to be merged into MainProfileId.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.MergeCPFProfileCmdlet.FieldSourceProfileIds_ShippingAddress"> <summary> <para> <para>A unique identifier for the shipping address field to be merged.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.MergeCPFProfileCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Message'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CustomerProfiles.Model.MergeProfilesResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.MergeProfilesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.MergeCPFProfileCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.MergeCPFProfileCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.NewCPFCalculatedAttributeDefinitionCmdlet"> <summary> Creates a new calculated attribute definition. After creation, new object data ingested into Customer Profiles will be included in the calculated attribute, which can be retrieved for a profile using the <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetCalculatedAttributeForProfile.html">GetCalculatedAttributeForProfile</a> API. Defining a calculated attribute makes it available for all profiles within a domain. Each calculated attribute can only reference one <c>ObjectType</c> and at most, two fields from that <c>ObjectType</c>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFCalculatedAttributeDefinitionCmdlet.AttributeDetails_Attribute"> <summary> <para> <para>A list of attribute items specified in the mathematical expression.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFCalculatedAttributeDefinitionCmdlet.CalculatedAttributeName"> <summary> <para> <para>The unique name of the calculated attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFCalculatedAttributeDefinitionCmdlet.Description"> <summary> <para> <para>The description of the calculated attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFCalculatedAttributeDefinitionCmdlet.DisplayName"> <summary> <para> <para>The display name of the calculated attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFCalculatedAttributeDefinitionCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFCalculatedAttributeDefinitionCmdlet.AttributeDetails_Expression"> <summary> <para> <para>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}\".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFCalculatedAttributeDefinitionCmdlet.Filter_Group"> <summary> <para> <para>Holds the list of Filter groups within the Filter definition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFCalculatedAttributeDefinitionCmdlet.Filter_Include"> <summary> <para> <para>Define whether to include or exclude objects for Calculated Attributed calculation that fit the filter groups criteria.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFCalculatedAttributeDefinitionCmdlet.Conditions_ObjectCount"> <summary> <para> <para>The number of profile objects used for the calculated attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFCalculatedAttributeDefinitionCmdlet.Threshold_Operator"> <summary> <para> <para>The operator of the threshold.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFCalculatedAttributeDefinitionCmdlet.Statistic"> <summary> <para> <para>The aggregation operation to perform for the calculated attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFCalculatedAttributeDefinitionCmdlet.Tag"> <summary> <para> <para>The tags used to organize, track, or control access for this resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFCalculatedAttributeDefinitionCmdlet.Range_Unit"> <summary> <para> <para>The unit of time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFCalculatedAttributeDefinitionCmdlet.Range_Value"> <summary> <para> <para>The amount of time of the specified unit.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFCalculatedAttributeDefinitionCmdlet.Threshold_Value"> <summary> <para> <para>The value of the threshold.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFCalculatedAttributeDefinitionCmdlet.Select"> <summary> 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.CreateCalculatedAttributeDefinitionResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.CreateCalculatedAttributeDefinitionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFCalculatedAttributeDefinitionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CalculatedAttributeName parameter. The -PassThru parameter is deprecated, use -Select '^CalculatedAttributeName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFCalculatedAttributeDefinitionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.NewCPFDomainCmdlet"> <summary> Creates a domain, which is a container for all customer data, such as customer profile attributes, object types, profile keys, and encryption keys. You can create multiple domains, and each domain can have multiple third-party integrations. <para> Each Amazon Connect instance can be associated with only one domain. Multiple Amazon Connect instances can be associated with one domain. </para><para> Use this API or <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UpdateDomain.html">UpdateDomain</a> to enable <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html">identity resolution</a>: set <c>Matching</c> to true. </para><para> To prevent cross-service impersonation when you call this API, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/cross-service-confused-deputy-prevention.html">Cross-service confused deputy prevention</a> for sample policies that you should apply. </para><note><para> It is not possible to associate a Customer Profiles domain with an Amazon Connect Instance directly from the API. If you would like to create a domain and associate a Customer Profiles domain, use the Amazon Connect admin website. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-customer-profiles.html#enable-customer-profiles-step1">Enable Customer Profiles</a>. </para><para> Each Amazon Connect instance can be associated with only one domain. Multiple Amazon Connect instances can be associated with one domain. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFDomainCmdlet.AttributeTypesSelector_Address"> <summary> <para> <para>The <c>Address</c> type. You can choose from <c>Address</c>, <c>BusinessAddress</c>, <c>MaillingAddress</c>, and <c>ShippingAddress</c>.</para><para>You only can use the Address type in the <c>MatchingRule</c>. For example, if you want to match profile based on <c>BusinessAddress.City</c> or <c>MaillingAddress.City</c>, you need to choose the <c>BusinessAddress</c> and the <c>MaillingAddress</c> to represent the Address type and specify the <c>Address.City</c> on the matching rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFDomainCmdlet.AttributeTypesSelector_AttributeMatchingModel"> <summary> <para> <para>Configures the <c>AttributeMatchingModel</c>, you can either choose <c>ONE_TO_ONE</c> or <c>MANY_TO_MANY</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFDomainCmdlet.ConflictResolution_ConflictResolvingModel"> <summary> <para> <para>How the auto-merging process should resolve conflicts between different profiles.</para><ul><li><para><c>RECENCY</c>: Uses the data that was most recently updated.</para></li><li><para><c>SOURCE</c>: 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 <c>RECENCY</c> is used again.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFDomainCmdlet.RuleBasedMatching_ConflictResolution_ConflictResolvingModel"> <summary> <para> <para>How the auto-merging process should resolve conflicts between different profiles.</para><ul><li><para><c>RECENCY</c>: Uses the data that was most recently updated.</para></li><li><para><c>SOURCE</c>: 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 <c>RECENCY</c> is used again.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFDomainCmdlet.JobSchedule_DayOfTheWeek"> <summary> <para> <para>The day when the Identity Resolution Job should run every week.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFDomainCmdlet.DeadLetterQueueUrl"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFDomainCmdlet.DefaultEncryptionKey"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFDomainCmdlet.DefaultExpirationDay"> <summary> <para> <para>The default number of days until the data within the domain expires.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFDomainCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFDomainCmdlet.AttributeTypesSelector_EmailAddress"> <summary> <para> <para>The <c>Email</c> type. You can choose from <c>EmailAddress</c>, <c>BusinessEmailAddress</c> and <c>PersonalEmailAddress</c>.</para><para>You only can use the <c>EmailAddress</c> type in the <c>MatchingRule</c>. For example, if you want to match profile based on <c>PersonalEmailAddress</c> or <c>BusinessEmailAddress</c>, you need to choose the <c>PersonalEmailAddress</c> and the <c>BusinessEmailAddress</c> to represent the <c>EmailAddress</c> type and only specify the <c>EmailAddress</c> on the matching rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFDomainCmdlet.AutoMerging_Enabled"> <summary> <para> <para>The flag that enables the auto-merging of duplicate profiles.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFDomainCmdlet.Matching_Enabled"> <summary> <para> <para>The flag that enables the matching process of duplicate profiles.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFDomainCmdlet.RuleBasedMatching_Enabled"> <summary> <para> <para>The flag that enables the rule-based matching process of duplicate profiles.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFDomainCmdlet.Consolidation_MatchingAttributesList"> <summary> <para> <para>A list of matching criteria.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFDomainCmdlet.RuleBasedMatching_MatchingRule"> <summary> <para> <para>Configures how the rule-based matching process should match profiles. You can have up to 15 <c>MatchingRule</c> in the <c>MatchingRules</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFDomainCmdlet.RuleBasedMatching_MaxAllowedRuleLevelForMatching"> <summary> <para> <para>Indicates the maximum allowed rule level.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFDomainCmdlet.RuleBasedMatching_MaxAllowedRuleLevelForMerging"> <summary> <para> <para><a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_MatchingRule.html">MatchingRule</a></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFDomainCmdlet.AutoMerging_MinAllowedConfidenceScoreForMerging"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFDomainCmdlet.AttributeTypesSelector_PhoneNumber"> <summary> <para> <para>The <c>PhoneNumber</c> type. You can choose from <c>PhoneNumber</c>, <c>HomePhoneNumber</c>, and <c>MobilePhoneNumber</c>.</para><para>You only can use the <c>PhoneNumber</c> type in the <c>MatchingRule</c>. For example, if you want to match a profile based on <c>Phone</c> or <c>HomePhone</c>, you need to choose the <c>Phone</c> and the <c>HomePhone</c> to represent the <c>PhoneNumber</c> type and only specify the <c>PhoneNumber</c> on the matching rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFDomainCmdlet.S3Exporting_S3BucketName"> <summary> <para> <para>The name of the S3 bucket where Identity Resolution Jobs write result files.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFDomainCmdlet.RuleBasedMatching_ExportingConfig_S3Exporting_S3BucketName"> <summary> <para> <para>The name of the S3 bucket where Identity Resolution Jobs write result files.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFDomainCmdlet.S3Exporting_S3KeyName"> <summary> <para> <para>The S3 key name of the location where Identity Resolution Jobs write result files.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFDomainCmdlet.RuleBasedMatching_ExportingConfig_S3Exporting_S3KeyName"> <summary> <para> <para>The S3 key name of the location where Identity Resolution Jobs write result files.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFDomainCmdlet.ConflictResolution_SourceName"> <summary> <para> <para>The <c>ObjectType</c> name that is used to resolve profile merging conflicts when choosing <c>SOURCE</c> as the <c>ConflictResolvingModel</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFDomainCmdlet.RuleBasedMatching_ConflictResolution_SourceName"> <summary> <para> <para>The <c>ObjectType</c> name that is used to resolve profile merging conflicts when choosing <c>SOURCE</c> as the <c>ConflictResolvingModel</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFDomainCmdlet.Tag"> <summary> <para> <para>The tags used to organize, track, or control access for this resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFDomainCmdlet.JobSchedule_Time"> <summary> <para> <para>The time when the Identity Resolution Job should run every week.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFDomainCmdlet.Select"> <summary> 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.CreateDomainResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.CreateDomainResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFDomainCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFDomainCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.NewCPFEventStreamCmdlet"> <summary> Creates an event stream, which is a subscription to real-time events, such as when profiles are created and updated through Amazon Connect Customer Profiles. <para> Each event stream can be associated with only one Kinesis Data Stream destination in the same region and Amazon Web Services account as the customer profiles domain </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFEventStreamCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFEventStreamCmdlet.EventStreamName"> <summary> <para> <para>The name of the event stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFEventStreamCmdlet.Tag"> <summary> <para> <para>The tags used to organize, track, or control access for this resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFEventStreamCmdlet.Uri"> <summary> <para> <para>The StreamARN of the destination to deliver profile events to. For example, arn:aws:kinesis:region:account-id:stream/stream-name</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFEventStreamCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EventStreamArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CustomerProfiles.Model.CreateEventStreamResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.CreateEventStreamResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFEventStreamCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Uri parameter. The -PassThru parameter is deprecated, use -Select '^Uri' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFEventStreamCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.NewCPFIntegrationWorkflowCmdlet"> <summary> Creates an integration workflow. An integration workflow is an async process which ingests historic data and sets up an integration for ongoing updates. The supported Amazon AppFlow sources are Salesforce, ServiceNow, and Marketo. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFIntegrationWorkflowCmdlet.AppflowIntegration_Batch"> <summary> <para> <para>Batches in workflow of type <c>APPFLOW_INTEGRATION</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFIntegrationWorkflowCmdlet.S3_BucketName"> <summary> <para> <para>The Amazon S3 bucket name where the source files are stored.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFIntegrationWorkflowCmdlet.S3_BucketPrefix"> <summary> <para> <para>The object key for the Amazon S3 bucket in which the source files are stored.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFIntegrationWorkflowCmdlet.SourceFlowConfig_ConnectorProfileName"> <summary> <para> <para>The name of the AppFlow connector profile. This name must be unique for each connector profile in the AWS account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFIntegrationWorkflowCmdlet.SourceFlowConfig_ConnectorType"> <summary> <para> <para>The type of connector, such as Salesforce, Marketo, and so on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFIntegrationWorkflowCmdlet.Scheduled_DataPullMode"> <summary> <para> <para>Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFIntegrationWorkflowCmdlet.IncrementalPullConfig_DatetimeTypeFieldName"> <summary> <para> <para>A field that specifies the date time or timestamp field as the criteria to use when importing incremental records from the source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFIntegrationWorkflowCmdlet.FlowDefinition_Description"> <summary> <para> <para>A description of the flow you want to create.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFIntegrationWorkflowCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFIntegrationWorkflowCmdlet.Salesforce_EnableDynamicFieldUpdate"> <summary> <para> <para>The flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects while running a flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFIntegrationWorkflowCmdlet.Scheduled_FirstExecutionFrom"> <summary> <para> <para>Specifies the date range for the records to import from the connector in the first flow run.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFIntegrationWorkflowCmdlet.FlowDefinition_FlowName"> <summary> <para> <para>The specified name of the flow. Use underscores (_) or hyphens (-) only. Spaces are not allowed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFIntegrationWorkflowCmdlet.Salesforce_IncludeDeletedRecord"> <summary> <para> <para>Indicates whether Amazon AppFlow includes deleted files in the flow run.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFIntegrationWorkflowCmdlet.FlowDefinition_KmsArn"> <summary> <para> <para>The Amazon Resource Name of the AWS Key Management Service (KMS) key you provide for encryption.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFIntegrationWorkflowCmdlet.Marketo_Object"> <summary> <para> <para>The object specified in the Marketo flow source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFIntegrationWorkflowCmdlet.Salesforce_Object"> <summary> <para> <para>The object specified in the Salesforce flow source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFIntegrationWorkflowCmdlet.ServiceNow_Object"> <summary> <para> <para>The object specified in the ServiceNow flow source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFIntegrationWorkflowCmdlet.Zendesk_Object"> <summary> <para> <para>The object specified in the Zendesk flow source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFIntegrationWorkflowCmdlet.ObjectTypeName"> <summary> <para> <para>The name of the profile object type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFIntegrationWorkflowCmdlet.RoleArn"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFIntegrationWorkflowCmdlet.Scheduled_ScheduleEndTime"> <summary> <para> <para>Specifies the scheduled end time for a scheduled-trigger flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFIntegrationWorkflowCmdlet.Scheduled_ScheduleExpression"> <summary> <para> <para>The scheduling expression that determines the rate at which the schedule will run, for example rate (5 minutes).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFIntegrationWorkflowCmdlet.Scheduled_ScheduleOffset"> <summary> <para> <para>Specifies the optional offset that is added to the time interval for a schedule-triggered flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFIntegrationWorkflowCmdlet.Scheduled_ScheduleStartTime"> <summary> <para> <para>Specifies the scheduled start time for a scheduled-trigger flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFIntegrationWorkflowCmdlet.Tag"> <summary> <para> <para>The tags used to organize, track, or control access for this resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFIntegrationWorkflowCmdlet.FlowDefinition_Task"> <summary> <para> <para>A list of tasks that Customer Profiles performs while transferring the data in the flow run.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFIntegrationWorkflowCmdlet.Scheduled_Timezone"> <summary> <para> <para>Specifies the time zone used when referring to the date and time of a scheduled-triggered flow, such as America/New_York.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFIntegrationWorkflowCmdlet.TriggerConfig_TriggerType"> <summary> <para> <para>Specifies the type of flow trigger. It can be OnDemand, Scheduled, or Event.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFIntegrationWorkflowCmdlet.WorkflowType"> <summary> <para> <para>The type of workflow. The only supported value is APPFLOW_INTEGRATION.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFIntegrationWorkflowCmdlet.Select"> <summary> 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.CreateIntegrationWorkflowResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.CreateIntegrationWorkflowResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFIntegrationWorkflowCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet"> <summary> Creates a standard profile. <para> A standard profile represents the following attributes for a customer profile in a domain. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.AccountNumber"> <summary> <para> <para>An account number that you have given to the customer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.AdditionalInformation"> <summary> <para> <para>Any additional information relevant to the customer’s profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.Address_Address1"> <summary> <para> <para>The first line of a customer address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.BillingAddress_Address1"> <summary> <para> <para>The first line of a customer address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.MailingAddress_Address1"> <summary> <para> <para>The first line of a customer address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.ShippingAddress_Address1"> <summary> <para> <para>The first line of a customer address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.Address_Address2"> <summary> <para> <para>The second line of a customer address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.BillingAddress_Address2"> <summary> <para> <para>The second line of a customer address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.MailingAddress_Address2"> <summary> <para> <para>The second line of a customer address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.ShippingAddress_Address2"> <summary> <para> <para>The second line of a customer address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.Address_Address3"> <summary> <para> <para>The third line of a customer address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.BillingAddress_Address3"> <summary> <para> <para>The third line of a customer address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.MailingAddress_Address3"> <summary> <para> <para>The third line of a customer address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.ShippingAddress_Address3"> <summary> <para> <para>The third line of a customer address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.Address_Address4"> <summary> <para> <para>The fourth line of a customer address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.BillingAddress_Address4"> <summary> <para> <para>The fourth line of a customer address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.MailingAddress_Address4"> <summary> <para> <para>The fourth line of a customer address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.ShippingAddress_Address4"> <summary> <para> <para>The fourth line of a customer address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.Attribute"> <summary> <para> <para>A key value pair of attributes of a customer profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.BirthDate"> <summary> <para> <para>The customer’s birth date. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.BusinessEmailAddress"> <summary> <para> <para>The customer’s business email address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.BusinessName"> <summary> <para> <para>The name of the customer’s business.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.BusinessPhoneNumber"> <summary> <para> <para>The customer’s business phone number.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.Address_City"> <summary> <para> <para>The city in which a customer lives.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.BillingAddress_City"> <summary> <para> <para>The city in which a customer lives.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.MailingAddress_City"> <summary> <para> <para>The city in which a customer lives.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.ShippingAddress_City"> <summary> <para> <para>The city in which a customer lives.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.Address_Country"> <summary> <para> <para>The country in which a customer lives.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.BillingAddress_Country"> <summary> <para> <para>The country in which a customer lives.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.MailingAddress_Country"> <summary> <para> <para>The country in which a customer lives.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.ShippingAddress_Country"> <summary> <para> <para>The country in which a customer lives.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.Address_County"> <summary> <para> <para>The county in which a customer lives.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.BillingAddress_County"> <summary> <para> <para>The county in which a customer lives.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.MailingAddress_County"> <summary> <para> <para>The county in which a customer lives.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.ShippingAddress_County"> <summary> <para> <para>The county in which a customer lives.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.EmailAddress"> <summary> <para> <para>The customer’s email address, which has not been specified as a personal or business address. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.FirstName"> <summary> <para> <para>The customer’s first name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.Gender"> <summary> <para> <para>The gender with which the customer identifies. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.GenderString"> <summary> <para> <para>An alternative to <c>Gender</c> which accepts any string as input.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.HomePhoneNumber"> <summary> <para> <para>The customer’s home phone number.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.LastName"> <summary> <para> <para>The customer’s last name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.MiddleName"> <summary> <para> <para>The customer’s middle name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.MobilePhoneNumber"> <summary> <para> <para>The customer’s mobile phone number.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.PartyType"> <summary> <para> <para>The type of profile used to describe the customer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.PartyTypeString"> <summary> <para> <para>An alternative to <c>PartyType</c> which accepts any string as input.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.PersonalEmailAddress"> <summary> <para> <para>The customer’s personal email address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.PhoneNumber"> <summary> <para> <para>The customer’s phone number, which has not been specified as a mobile, home, or business number. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.Address_PostalCode"> <summary> <para> <para>The postal code of a customer address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.BillingAddress_PostalCode"> <summary> <para> <para>The postal code of a customer address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.MailingAddress_PostalCode"> <summary> <para> <para>The postal code of a customer address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.ShippingAddress_PostalCode"> <summary> <para> <para>The postal code of a customer address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.Address_Province"> <summary> <para> <para>The province in which a customer lives.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.BillingAddress_Province"> <summary> <para> <para>The province in which a customer lives.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.MailingAddress_Province"> <summary> <para> <para>The province in which a customer lives.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.ShippingAddress_Province"> <summary> <para> <para>The province in which a customer lives.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.Address_State"> <summary> <para> <para>The state in which a customer lives.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.BillingAddress_State"> <summary> <para> <para>The state in which a customer lives.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.MailingAddress_State"> <summary> <para> <para>The state in which a customer lives.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.ShippingAddress_State"> <summary> <para> <para>The state in which a customer lives.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ProfileId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CustomerProfiles.Model.CreateProfileResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.CreateProfileResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFProfileCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.NewCPFSegmentDefinitionCmdlet"> <summary> Creates a segment definition associated to the given domain. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFSegmentDefinitionCmdlet.Description"> <summary> <para> <para>The description of the segment definition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFSegmentDefinitionCmdlet.DisplayName"> <summary> <para> <para>The display name of the segment definition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFSegmentDefinitionCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFSegmentDefinitionCmdlet.SegmentGroups_Group"> <summary> <para> <para>Holds the list of groups within the segment definition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFSegmentDefinitionCmdlet.SegmentGroups_Include"> <summary> <para> <para>Defines whether to include or exclude the profiles that fit the segment criteria.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFSegmentDefinitionCmdlet.SegmentDefinitionName"> <summary> <para> <para>The unique name of the segment definition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFSegmentDefinitionCmdlet.Tag"> <summary> <para> <para>The tags used to organize, track, or control access for this resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFSegmentDefinitionCmdlet.Select"> <summary> 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.CreateSegmentDefinitionResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.CreateSegmentDefinitionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFSegmentDefinitionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SegmentDefinitionName parameter. The -PassThru parameter is deprecated, use -Select '^SegmentDefinitionName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFSegmentDefinitionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.NewCPFSegmentEstimateCmdlet"> <summary> Creates a segment estimate query. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFSegmentEstimateCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFSegmentEstimateCmdlet.SegmentQuery_Group"> <summary> <para> <para>Holds the list of groups within the segment definition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFSegmentEstimateCmdlet.SegmentQuery_Include"> <summary> <para> <para>Define whether to include or exclude the profiles that fit the segment criteria.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFSegmentEstimateCmdlet.Select"> <summary> 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.CreateSegmentEstimateResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.CreateSegmentEstimateResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFSegmentEstimateCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFSegmentEstimateCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.NewCPFSegmentSnapshotCmdlet"> <summary> Triggers a job to export a segment to a specified destination. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFSegmentSnapshotCmdlet.DataFormat"> <summary> <para> <para>The format in which the segment will be exported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFSegmentSnapshotCmdlet.DestinationUri"> <summary> <para> <para>The destination to which the segment will be exported. This field must be provided if the request is not submitted from the Amazon Connect Admin Website.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFSegmentSnapshotCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFSegmentSnapshotCmdlet.EncryptionKey"> <summary> <para> <para>The Amazon Resource Name (ARN) of the KMS key used to encrypt the exported segment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFSegmentSnapshotCmdlet.RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM role that allows Customer Profiles service principal to assume the role for conducting KMS and S3 operations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFSegmentSnapshotCmdlet.SegmentDefinitionName"> <summary> <para> <para>The name of the segment definition used in this snapshot request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFSegmentSnapshotCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SnapshotId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CustomerProfiles.Model.CreateSegmentSnapshotResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.CreateSegmentSnapshotResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFSegmentSnapshotCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SegmentDefinitionName parameter. The -PassThru parameter is deprecated, use -Select '^SegmentDefinitionName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.NewCPFSegmentSnapshotCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFCalculatedAttributeDefinitionCmdlet"> <summary> Deletes an existing calculated attribute definition. Note that deleting a default calculated attribute is possible, however once deleted, you will be unable to undo that action and will need to recreate it on your own using the CreateCalculatedAttributeDefinition API if you want it back. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFCalculatedAttributeDefinitionCmdlet.CalculatedAttributeName"> <summary> <para> <para>The unique name of the calculated attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFCalculatedAttributeDefinitionCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFCalculatedAttributeDefinitionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CustomerProfiles.Model.DeleteCalculatedAttributeDefinitionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFCalculatedAttributeDefinitionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CalculatedAttributeName parameter. The -PassThru parameter is deprecated, use -Select '^CalculatedAttributeName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFCalculatedAttributeDefinitionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFDomainCmdlet"> <summary> Deletes a specific domain and all of its customer data, such as customer profile attributes and their related objects. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFDomainCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFDomainCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Message'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CustomerProfiles.Model.DeleteDomainResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.DeleteDomainResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFDomainCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFDomainCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFEventStreamCmdlet"> <summary> Disables and deletes the specified event stream. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFEventStreamCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFEventStreamCmdlet.EventStreamName"> <summary> <para> <para>The name of the event stream</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFEventStreamCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CustomerProfiles.Model.DeleteEventStreamResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFEventStreamCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EventStreamName parameter. The -PassThru parameter is deprecated, use -Select '^EventStreamName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFEventStreamCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFIntegrationCmdlet"> <summary> Removes an integration from a specific domain. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFIntegrationCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFIntegrationCmdlet.Uri"> <summary> <para> <para>The URI of the S3 bucket or any other type of data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFIntegrationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Message'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CustomerProfiles.Model.DeleteIntegrationResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.DeleteIntegrationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFIntegrationCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFIntegrationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFProfileCmdlet"> <summary> Deletes the standard customer profile and all data pertaining to the profile. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFProfileCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFProfileCmdlet.ProfileId"> <summary> <para> <para>The unique identifier of a customer profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFProfileCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Message'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CustomerProfiles.Model.DeleteProfileResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.DeleteProfileResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFProfileCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProfileId parameter. The -PassThru parameter is deprecated, use -Select '^ProfileId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFProfileCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFProfileKeyCmdlet"> <summary> Removes a searchable key from a customer profile. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFProfileKeyCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFProfileKeyCmdlet.KeyName"> <summary> <para> <para>A searchable identifier of a customer profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFProfileKeyCmdlet.ProfileId"> <summary> <para> <para>The unique identifier of a customer profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFProfileKeyCmdlet.Value"> <summary> <para> <para>A list of key values.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFProfileKeyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Message'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CustomerProfiles.Model.DeleteProfileKeyResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.DeleteProfileKeyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFProfileKeyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProfileId parameter. The -PassThru parameter is deprecated, use -Select '^ProfileId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFProfileKeyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFProfileObjectCmdlet"> <summary> Removes an object associated with a profile of a given ProfileObjectType. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFProfileObjectCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFProfileObjectCmdlet.ObjectTypeName"> <summary> <para> <para>The name of the profile object type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFProfileObjectCmdlet.ProfileId"> <summary> <para> <para>The unique identifier of a customer profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFProfileObjectCmdlet.ProfileObjectUniqueKey"> <summary> <para> <para>The unique identifier of the profile object generated by the service.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFProfileObjectCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Message'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CustomerProfiles.Model.DeleteProfileObjectResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.DeleteProfileObjectResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFProfileObjectCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProfileObjectUniqueKey parameter. The -PassThru parameter is deprecated, use -Select '^ProfileObjectUniqueKey' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFProfileObjectCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFProfileObjectTypeCmdlet"> <summary> Removes a ProfileObjectType from a specific domain as well as removes all the ProfileObjects of that type. It also disables integrations from this specific ProfileObjectType. In addition, it scrubs all of the fields of the standard profile that were populated from this ProfileObjectType. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFProfileObjectTypeCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFProfileObjectTypeCmdlet.ObjectTypeName"> <summary> <para> <para>The name of the profile object type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFProfileObjectTypeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Message'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CustomerProfiles.Model.DeleteProfileObjectTypeResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.DeleteProfileObjectTypeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFProfileObjectTypeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ObjectTypeName parameter. The -PassThru parameter is deprecated, use -Select '^ObjectTypeName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFProfileObjectTypeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFResourceTagCmdlet"> <summary> Removes one or more tags from the specified Amazon Connect Customer Profiles resource. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the resource from which you are removing tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFResourceTagCmdlet.TagKey"> <summary> <para> <para>The list of tag keys to remove from the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CustomerProfiles.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFSegmentDefinitionCmdlet"> <summary> Deletes a segment definition from the domain. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFSegmentDefinitionCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFSegmentDefinitionCmdlet.SegmentDefinitionName"> <summary> <para> <para>The unique name of the segment definition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFSegmentDefinitionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Message'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CustomerProfiles.Model.DeleteSegmentDefinitionResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.DeleteSegmentDefinitionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFSegmentDefinitionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SegmentDefinitionName parameter. The -PassThru parameter is deprecated, use -Select '^SegmentDefinitionName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFSegmentDefinitionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFWorkflowCmdlet"> <summary> Deletes the specified workflow and all its corresponding resources. This is an async process. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFWorkflowCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFWorkflowCmdlet.WorkflowId"> <summary> <para> <para>Unique identifier for the workflow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFWorkflowCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CustomerProfiles.Model.DeleteWorkflowResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFWorkflowCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WorkflowId parameter. The -PassThru parameter is deprecated, use -Select '^WorkflowId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.RemoveCPFWorkflowCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.SearchCPFProfileCmdlet"> <summary> Searches for profiles within a specific domain using one or more predefined search keys (e.g., _fullName, _phone, _email, _account, etc.) and/or custom-defined search keys. A search key is a data type pair that consists of a <c>KeyName</c> and <c>Values</c> list. <para> This operation supports searching for profiles with a minimum of 1 key-value(s) pair and up to 5 key-value(s) pairs using either <c>AND</c> or <c>OR</c> logic. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.SearchCPFProfileCmdlet.AdditionalSearchKey"> <summary> <para> <para>A list of <c>AdditionalSearchKey</c> objects that are each searchable identifiers of a profile. Each <c>AdditionalSearchKey</c> object contains a <c>KeyName</c> and a list of <c>Values</c> associated with that specific key (i.e., a key-value(s) pair). These additional search keys will be used in conjunction with the <c>LogicalOperator</c> and the required <c>KeyName</c> and <c>Values</c> parameters to search for profiles that satisfy the search criteria. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.SearchCPFProfileCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.SearchCPFProfileCmdlet.KeyName"> <summary> <para> <para>A searchable identifier of a customer profile. The predefined keys you can use to search include: _account, _profileId, _assetId, _caseId, _orderId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, _salesforceAssetId, _zendeskUserId, _zendeskExternalId, _zendeskTicketId, _serviceNowSystemId, _serviceNowIncidentId, _segmentUserId, _shopifyCustomerId, _shopifyOrderId.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.SearchCPFProfileCmdlet.LogicalOperator"> <summary> <para> <para>Relationship between all specified search keys that will be used to search for profiles. This includes the required <c>KeyName</c> and <c>Values</c> parameters as well as any key-value(s) pairs specified in the <c>AdditionalSearchKeys</c> list.</para><para>This parameter influences which profiles will be returned in the response in the following manner:</para><ul><li><para><c>AND</c> - The response only includes profiles that match all of the search keys.</para></li><li><para><c>OR</c> - The response includes profiles that match at least one of the search keys.</para></li></ul><para>The <c>OR</c> relationship is the default behavior if this parameter is not included in the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.SearchCPFProfileCmdlet.Value"> <summary> <para> <para>A list of key values.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.SearchCPFProfileCmdlet.MaxResult"> <summary> <para> <para>The maximum number of objects returned per page.</para><para>The default is 20 if this parameter is not included in the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.SearchCPFProfileCmdlet.NextToken"> <summary> <para> <para>The pagination token from the previous SearchProfiles API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.SearchCPFProfileCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Items'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CustomerProfiles.Model.SearchProfilesResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.SearchProfilesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.SearchCPFProfileCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFCalculatedAttributeDefinitionCmdlet"> <summary> Updates an existing calculated attribute definition. When updating the Conditions, note that increasing the date range of a calculated attribute will not trigger inclusion of historical data greater than the current date range. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFCalculatedAttributeDefinitionCmdlet.CalculatedAttributeName"> <summary> <para> <para>The unique name of the calculated attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFCalculatedAttributeDefinitionCmdlet.Description"> <summary> <para> <para>The description of the calculated attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFCalculatedAttributeDefinitionCmdlet.DisplayName"> <summary> <para> <para>The display name of the calculated attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFCalculatedAttributeDefinitionCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFCalculatedAttributeDefinitionCmdlet.Conditions_ObjectCount"> <summary> <para> <para>The number of profile objects used for the calculated attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFCalculatedAttributeDefinitionCmdlet.Threshold_Operator"> <summary> <para> <para>The operator of the threshold.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFCalculatedAttributeDefinitionCmdlet.Range_Unit"> <summary> <para> <para>The unit of time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFCalculatedAttributeDefinitionCmdlet.Range_Value"> <summary> <para> <para>The amount of time of the specified unit.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFCalculatedAttributeDefinitionCmdlet.Threshold_Value"> <summary> <para> <para>The value of the threshold.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFCalculatedAttributeDefinitionCmdlet.Select"> <summary> 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.UpdateCalculatedAttributeDefinitionResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.UpdateCalculatedAttributeDefinitionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFCalculatedAttributeDefinitionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the CalculatedAttributeName parameter. The -PassThru parameter is deprecated, use -Select '^CalculatedAttributeName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFCalculatedAttributeDefinitionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFDomainCmdlet"> <summary> Updates the properties of a domain, including creating or selecting a dead letter queue or an encryption key. <para> After a domain is created, the name can’t be changed. </para><para> Use this API or <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_CreateDomain.html">CreateDomain</a> to enable <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html">identity resolution</a>: set <c>Matching</c> to true. </para><para> To prevent cross-service impersonation when you call this API, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/cross-service-confused-deputy-prevention.html">Cross-service confused deputy prevention</a> for sample policies that you should apply. </para><para> To add or remove tags on an existing Domain, see <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_TagResource.html">TagResource</a>/<a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UntagResource.html">UntagResource</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFDomainCmdlet.AttributeTypesSelector_Address"> <summary> <para> <para>The <c>Address</c> type. You can choose from <c>Address</c>, <c>BusinessAddress</c>, <c>MaillingAddress</c>, and <c>ShippingAddress</c>.</para><para>You only can use the Address type in the <c>MatchingRule</c>. For example, if you want to match profile based on <c>BusinessAddress.City</c> or <c>MaillingAddress.City</c>, you need to choose the <c>BusinessAddress</c> and the <c>MaillingAddress</c> to represent the Address type and specify the <c>Address.City</c> on the matching rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFDomainCmdlet.AttributeTypesSelector_AttributeMatchingModel"> <summary> <para> <para>Configures the <c>AttributeMatchingModel</c>, you can either choose <c>ONE_TO_ONE</c> or <c>MANY_TO_MANY</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFDomainCmdlet.ConflictResolution_ConflictResolvingModel"> <summary> <para> <para>How the auto-merging process should resolve conflicts between different profiles.</para><ul><li><para><c>RECENCY</c>: Uses the data that was most recently updated.</para></li><li><para><c>SOURCE</c>: 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 <c>RECENCY</c> is used again.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFDomainCmdlet.RuleBasedMatching_ConflictResolution_ConflictResolvingModel"> <summary> <para> <para>How the auto-merging process should resolve conflicts between different profiles.</para><ul><li><para><c>RECENCY</c>: Uses the data that was most recently updated.</para></li><li><para><c>SOURCE</c>: 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 <c>RECENCY</c> is used again.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFDomainCmdlet.JobSchedule_DayOfTheWeek"> <summary> <para> <para>The day when the Identity Resolution Job should run every week.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFDomainCmdlet.DeadLetterQueueUrl"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFDomainCmdlet.DefaultEncryptionKey"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFDomainCmdlet.DefaultExpirationDay"> <summary> <para> <para>The default number of days until the data within the domain expires.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFDomainCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFDomainCmdlet.AttributeTypesSelector_EmailAddress"> <summary> <para> <para>The <c>Email</c> type. You can choose from <c>EmailAddress</c>, <c>BusinessEmailAddress</c> and <c>PersonalEmailAddress</c>.</para><para>You only can use the <c>EmailAddress</c> type in the <c>MatchingRule</c>. For example, if you want to match profile based on <c>PersonalEmailAddress</c> or <c>BusinessEmailAddress</c>, you need to choose the <c>PersonalEmailAddress</c> and the <c>BusinessEmailAddress</c> to represent the <c>EmailAddress</c> type and only specify the <c>EmailAddress</c> on the matching rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFDomainCmdlet.AutoMerging_Enabled"> <summary> <para> <para>The flag that enables the auto-merging of duplicate profiles.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFDomainCmdlet.Matching_Enabled"> <summary> <para> <para>The flag that enables the matching process of duplicate profiles.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFDomainCmdlet.RuleBasedMatching_Enabled"> <summary> <para> <para>The flag that enables the rule-based matching process of duplicate profiles.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFDomainCmdlet.Consolidation_MatchingAttributesList"> <summary> <para> <para>A list of matching criteria.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFDomainCmdlet.RuleBasedMatching_MatchingRule"> <summary> <para> <para>Configures how the rule-based matching process should match profiles. You can have up to 15 <c>MatchingRule</c> in the <c>MatchingRules</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFDomainCmdlet.RuleBasedMatching_MaxAllowedRuleLevelForMatching"> <summary> <para> <para>Indicates the maximum allowed rule level.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFDomainCmdlet.RuleBasedMatching_MaxAllowedRuleLevelForMerging"> <summary> <para> <para><a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_MatchingRule.html">MatchingRule</a></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFDomainCmdlet.AutoMerging_MinAllowedConfidenceScoreForMerging"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFDomainCmdlet.AttributeTypesSelector_PhoneNumber"> <summary> <para> <para>The <c>PhoneNumber</c> type. You can choose from <c>PhoneNumber</c>, <c>HomePhoneNumber</c>, and <c>MobilePhoneNumber</c>.</para><para>You only can use the <c>PhoneNumber</c> type in the <c>MatchingRule</c>. For example, if you want to match a profile based on <c>Phone</c> or <c>HomePhone</c>, you need to choose the <c>Phone</c> and the <c>HomePhone</c> to represent the <c>PhoneNumber</c> type and only specify the <c>PhoneNumber</c> on the matching rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFDomainCmdlet.S3Exporting_S3BucketName"> <summary> <para> <para>The name of the S3 bucket where Identity Resolution Jobs write result files.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFDomainCmdlet.RuleBasedMatching_ExportingConfig_S3Exporting_S3BucketName"> <summary> <para> <para>The name of the S3 bucket where Identity Resolution Jobs write result files.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFDomainCmdlet.S3Exporting_S3KeyName"> <summary> <para> <para>The S3 key name of the location where Identity Resolution Jobs write result files.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFDomainCmdlet.RuleBasedMatching_ExportingConfig_S3Exporting_S3KeyName"> <summary> <para> <para>The S3 key name of the location where Identity Resolution Jobs write result files.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFDomainCmdlet.ConflictResolution_SourceName"> <summary> <para> <para>The <c>ObjectType</c> name that is used to resolve profile merging conflicts when choosing <c>SOURCE</c> as the <c>ConflictResolvingModel</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFDomainCmdlet.RuleBasedMatching_ConflictResolution_SourceName"> <summary> <para> <para>The <c>ObjectType</c> name that is used to resolve profile merging conflicts when choosing <c>SOURCE</c> as the <c>ConflictResolvingModel</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFDomainCmdlet.Tag"> <summary> <para> <para>The tags used to organize, track, or control access for this resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFDomainCmdlet.JobSchedule_Time"> <summary> <para> <para>The time when the Identity Resolution Job should run every week.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFDomainCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFDomainCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFDomainCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet"> <summary> Updates the properties of a profile. The ProfileId is required for updating a customer profile. <para> When calling the UpdateProfile API, specifying an empty string value means that any existing value will be removed. Not specifying a string value means that any value already there will be kept. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.AccountNumber"> <summary> <para> <para>An account number that you have given to the customer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.AdditionalInformation"> <summary> <para> <para>Any additional information relevant to the customer’s profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.Address_Address1"> <summary> <para> <para>The first line of a customer address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.BillingAddress_Address1"> <summary> <para> <para>The first line of a customer address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.MailingAddress_Address1"> <summary> <para> <para>The first line of a customer address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.ShippingAddress_Address1"> <summary> <para> <para>The first line of a customer address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.Address_Address2"> <summary> <para> <para>The second line of a customer address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.BillingAddress_Address2"> <summary> <para> <para>The second line of a customer address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.MailingAddress_Address2"> <summary> <para> <para>The second line of a customer address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.ShippingAddress_Address2"> <summary> <para> <para>The second line of a customer address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.Address_Address3"> <summary> <para> <para>The third line of a customer address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.BillingAddress_Address3"> <summary> <para> <para>The third line of a customer address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.MailingAddress_Address3"> <summary> <para> <para>The third line of a customer address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.ShippingAddress_Address3"> <summary> <para> <para>The third line of a customer address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.Address_Address4"> <summary> <para> <para>The fourth line of a customer address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.BillingAddress_Address4"> <summary> <para> <para>The fourth line of a customer address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.MailingAddress_Address4"> <summary> <para> <para>The fourth line of a customer address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.ShippingAddress_Address4"> <summary> <para> <para>The fourth line of a customer address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.Attribute"> <summary> <para> <para>A key value pair of attributes of a customer profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.BirthDate"> <summary> <para> <para>The customer’s birth date. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.BusinessEmailAddress"> <summary> <para> <para>The customer’s business email address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.BusinessName"> <summary> <para> <para>The name of the customer’s business.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.BusinessPhoneNumber"> <summary> <para> <para>The customer’s business phone number.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.Address_City"> <summary> <para> <para>The city in which a customer lives.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.BillingAddress_City"> <summary> <para> <para>The city in which a customer lives.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.MailingAddress_City"> <summary> <para> <para>The city in which a customer lives.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.ShippingAddress_City"> <summary> <para> <para>The city in which a customer lives.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.Address_Country"> <summary> <para> <para>The country in which a customer lives.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.BillingAddress_Country"> <summary> <para> <para>The country in which a customer lives.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.MailingAddress_Country"> <summary> <para> <para>The country in which a customer lives.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.ShippingAddress_Country"> <summary> <para> <para>The country in which a customer lives.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.Address_County"> <summary> <para> <para>The county in which a customer lives.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.BillingAddress_County"> <summary> <para> <para>The county in which a customer lives.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.MailingAddress_County"> <summary> <para> <para>The county in which a customer lives.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.ShippingAddress_County"> <summary> <para> <para>The county in which a customer lives.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.EmailAddress"> <summary> <para> <para>The customer’s email address, which has not been specified as a personal or business address. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.FirstName"> <summary> <para> <para>The customer’s first name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.Gender"> <summary> <para> <para>The gender with which the customer identifies. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.GenderString"> <summary> <para> <para>An alternative to <c>Gender</c> which accepts any string as input.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.HomePhoneNumber"> <summary> <para> <para>The customer’s home phone number.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.LastName"> <summary> <para> <para>The customer’s last name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.MiddleName"> <summary> <para> <para>The customer’s middle name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.MobilePhoneNumber"> <summary> <para> <para>The customer’s mobile phone number.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.PartyType"> <summary> <para> <para>The type of profile used to describe the customer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.PartyTypeString"> <summary> <para> <para>An alternative to <c>PartyType</c> which accepts any string as input.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.PersonalEmailAddress"> <summary> <para> <para>The customer’s personal email address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.PhoneNumber"> <summary> <para> <para>The customer’s phone number, which has not been specified as a mobile, home, or business number. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.Address_PostalCode"> <summary> <para> <para>The postal code of a customer address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.BillingAddress_PostalCode"> <summary> <para> <para>The postal code of a customer address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.MailingAddress_PostalCode"> <summary> <para> <para>The postal code of a customer address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.ShippingAddress_PostalCode"> <summary> <para> <para>The postal code of a customer address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.ProfileId"> <summary> <para> <para>The unique identifier of a customer profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.Address_Province"> <summary> <para> <para>The province in which a customer lives.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.BillingAddress_Province"> <summary> <para> <para>The province in which a customer lives.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.MailingAddress_Province"> <summary> <para> <para>The province in which a customer lives.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.ShippingAddress_Province"> <summary> <para> <para>The province in which a customer lives.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.Address_State"> <summary> <para> <para>The state in which a customer lives.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.BillingAddress_State"> <summary> <para> <para>The state in which a customer lives.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.MailingAddress_State"> <summary> <para> <para>The state in which a customer lives.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.ShippingAddress_State"> <summary> <para> <para>The state in which a customer lives.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ProfileId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CustomerProfiles.Model.UpdateProfileResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.UpdateProfileResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProfileId parameter. The -PassThru parameter is deprecated, use -Select '^ProfileId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.UpdateCPFProfileCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.WriteCPFIntegrationCmdlet"> <summary> Adds an integration between the service and a third-party service, which includes Amazon AppFlow and Amazon Connect. <para> An integration can belong to only one domain. </para><para> To add or remove tags on an existing Integration, see <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_TagResource.html"> TagResource </a>/<a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UntagResource.html"> UntagResource</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFIntegrationCmdlet.S3_BucketName"> <summary> <para> <para>The Amazon S3 bucket name where the source files are stored.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFIntegrationCmdlet.S3_BucketPrefix"> <summary> <para> <para>The object key for the Amazon S3 bucket in which the source files are stored.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFIntegrationCmdlet.SourceFlowConfig_ConnectorProfileName"> <summary> <para> <para>The name of the AppFlow connector profile. This name must be unique for each connector profile in the AWS account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFIntegrationCmdlet.SourceFlowConfig_ConnectorType"> <summary> <para> <para>The type of connector, such as Salesforce, Marketo, and so on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFIntegrationCmdlet.Scheduled_DataPullMode"> <summary> <para> <para>Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFIntegrationCmdlet.IncrementalPullConfig_DatetimeTypeFieldName"> <summary> <para> <para>A field that specifies the date time or timestamp field as the criteria to use when importing incremental records from the source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFIntegrationCmdlet.FlowDefinition_Description"> <summary> <para> <para>A description of the flow you want to create.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFIntegrationCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFIntegrationCmdlet.Salesforce_EnableDynamicFieldUpdate"> <summary> <para> <para>The flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects while running a flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFIntegrationCmdlet.Scheduled_FirstExecutionFrom"> <summary> <para> <para>Specifies the date range for the records to import from the connector in the first flow run.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFIntegrationCmdlet.FlowDefinition_FlowName"> <summary> <para> <para>The specified name of the flow. Use underscores (_) or hyphens (-) only. Spaces are not allowed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFIntegrationCmdlet.Salesforce_IncludeDeletedRecord"> <summary> <para> <para>Indicates whether Amazon AppFlow includes deleted files in the flow run.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFIntegrationCmdlet.FlowDefinition_KmsArn"> <summary> <para> <para>The Amazon Resource Name of the AWS Key Management Service (KMS) key you provide for encryption.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFIntegrationCmdlet.Marketo_Object"> <summary> <para> <para>The object specified in the Marketo flow source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFIntegrationCmdlet.Salesforce_Object"> <summary> <para> <para>The object specified in the Salesforce flow source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFIntegrationCmdlet.ServiceNow_Object"> <summary> <para> <para>The object specified in the ServiceNow flow source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFIntegrationCmdlet.Zendesk_Object"> <summary> <para> <para>The object specified in the Zendesk flow source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFIntegrationCmdlet.ObjectTypeName"> <summary> <para> <para>The name of the profile object type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFIntegrationCmdlet.ObjectTypeNames"> <summary> <para> <para>A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an <c>ObjectTypeName</c> (template) used to ingest the event. It supports the following event types: <c>SegmentIdentify</c>, <c>ShopifyCreateCustomers</c>, <c>ShopifyUpdateCustomers</c>, <c>ShopifyCreateDraftOrders</c>, <c>ShopifyUpdateDraftOrders</c>, <c>ShopifyCreateOrders</c>, and <c>ShopifyUpdatedOrders</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFIntegrationCmdlet.RoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM role. The Integration uses this role to make Customer Profiles requests on your behalf.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFIntegrationCmdlet.Scheduled_ScheduleEndTime"> <summary> <para> <para>Specifies the scheduled end time for a scheduled-trigger flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFIntegrationCmdlet.Scheduled_ScheduleExpression"> <summary> <para> <para>The scheduling expression that determines the rate at which the schedule will run, for example rate (5 minutes).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFIntegrationCmdlet.Scheduled_ScheduleOffset"> <summary> <para> <para>Specifies the optional offset that is added to the time interval for a schedule-triggered flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFIntegrationCmdlet.Scheduled_ScheduleStartTime"> <summary> <para> <para>Specifies the scheduled start time for a scheduled-trigger flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFIntegrationCmdlet.Tag"> <summary> <para> <para>The tags used to organize, track, or control access for this resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFIntegrationCmdlet.FlowDefinition_Task"> <summary> <para> <para>A list of tasks that Customer Profiles performs while transferring the data in the flow run.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFIntegrationCmdlet.Scheduled_Timezone"> <summary> <para> <para>Specifies the time zone used when referring to the date and time of a scheduled-triggered flow, such as America/New_York.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFIntegrationCmdlet.TriggerConfig_TriggerType"> <summary> <para> <para>Specifies the type of flow trigger. It can be OnDemand, Scheduled, or Event.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFIntegrationCmdlet.Uri"> <summary> <para> <para>The URI of the S3 bucket or any other type of data source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFIntegrationCmdlet.Select"> <summary> 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.PutIntegrationResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.PutIntegrationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFIntegrationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Uri parameter. The -PassThru parameter is deprecated, use -Select '^Uri' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFIntegrationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.WriteCPFProfileObjectCmdlet"> <summary> Adds additional objects to customer profiles of a given ObjectType. <para> When adding a specific profile object, like a Contact Record, an inferred profile can get created if it is not mapped to an existing profile. The resulting profile will only have a phone number populated in the standard ProfileObject. Any additional Contact Records with the same phone number will be mapped to the same inferred profile. </para><para> When a ProfileObject is created and if a ProfileObjectType already exists for the ProfileObject, it will provide data to a standard profile depending on the ProfileObjectType definition. </para><para> PutProfileObject needs an ObjectType, which can be created using PutProfileObjectType. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFProfileObjectCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFProfileObjectCmdlet.Object"> <summary> <para> <para>A string that is serialized from a JSON object.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFProfileObjectCmdlet.ObjectTypeName"> <summary> <para> <para>The name of the profile object type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFProfileObjectCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ProfileObjectUniqueKey'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CustomerProfiles.Model.PutProfileObjectResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.PutProfileObjectResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFProfileObjectCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ObjectTypeName parameter. The -PassThru parameter is deprecated, use -Select '^ObjectTypeName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFProfileObjectCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CPF.WriteCPFProfileObjectTypeCmdlet"> <summary> Defines a ProfileObjectType. <para> To add or remove tags on an existing ObjectType, see <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_TagResource.html"> TagResource</a>/<a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UntagResource.html">UntagResource</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFProfileObjectTypeCmdlet.AllowProfileCreation"> <summary> <para> <para>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 <c>FALSE</c>. If the AllowProfileCreation flag is set to <c>FALSE</c>, then the service tries to fetch a standard profile and associate this object with the profile. If it is set to <c>TRUE</c>, and if no match is found, then the service creates a new standard profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFProfileObjectTypeCmdlet.Description"> <summary> <para> <para>Description of the profile object type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFProfileObjectTypeCmdlet.DomainName"> <summary> <para> <para>The unique name of the domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFProfileObjectTypeCmdlet.EncryptionKey"> <summary> <para> <para>The customer-provided key to encrypt the profile object that will be created in this profile object type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFProfileObjectTypeCmdlet.ExpirationDay"> <summary> <para> <para>The number of days until the data in the object expires.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFProfileObjectTypeCmdlet.Field"> <summary> <para> <para>A map of the name and ObjectType field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFProfileObjectTypeCmdlet.Key"> <summary> <para> <para>A list of unique keys that can be used to map data to the profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFProfileObjectTypeCmdlet.MaxProfileObjectCount"> <summary> <para> <para>The amount of profile object max count assigned to the object type</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFProfileObjectTypeCmdlet.ObjectTypeName"> <summary> <para> <para>The name of the profile object type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFProfileObjectTypeCmdlet.SourceLastUpdatedTimestampFormat"> <summary> <para> <para>The format of your <c>sourceLastUpdatedTimestamp</c> that was previously set up. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFProfileObjectTypeCmdlet.Tag"> <summary> <para> <para>The tags used to organize, track, or control access for this resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFProfileObjectTypeCmdlet.TemplateId"> <summary> <para> <para>A unique identifier for the object template. For some attributes in the request, the service will use the default value from the object template when TemplateId is present. If these attributes are present in the request, the service may return a <c>BadRequestException</c>. These attributes include: AllowProfileCreation, SourceLastUpdatedTimestampFormat, Fields, and Keys. For example, if AllowProfileCreation is set to true when TemplateId is set, the service may return a <c>BadRequestException</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFProfileObjectTypeCmdlet.Select"> <summary> 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.PutProfileObjectTypeResponse). Specifying the name of a property of type Amazon.CustomerProfiles.Model.PutProfileObjectTypeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFProfileObjectTypeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ObjectTypeName parameter. The -PassThru parameter is deprecated, use -Select '^ObjectTypeName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CPF.WriteCPFProfileObjectTypeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |