domains_list_only
Lists domains
in a region or regions, for all properties use domains
Overview
Name | domains_list_only |
Type | Resource |
Description | A domain defined for 3rd party data source in Profile Service |
Id | aws.customerprofiles.domains_list_only |
Fields
Name | Datatype | Description |
---|---|---|
domain_name | string | The unique name of the domain. |
dead_letter_queue_url | string | The URL of the SQS dead letter queue |
default_encryption_key | string | The default encryption key |
default_expiration_days | integer | The default number of days until the data within the domain expires. |
matching | object | The process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains. After the Identity Resolution Job completes, use the GetMatches API to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from S3. |
rule_based_matching | object | The process of matching duplicate profiles using the Rule-Based matching. If RuleBasedMatching = true, Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration in the RuleBasedMatchingRequest. You can use the ListRuleBasedMatches and GetSimilarProfiles API to return and review the results. Also, if you have configured ExportingConfig in the RuleBasedMatchingRequest, you can download the results from S3. |
stats | object | Usage-specific statistics about the domain. |
tags | array | The tags (keys and values) associated with the domain |
created_at | string | The time of this integration got created |
last_updated_at | string | The time of this integration got last updated at |
region | string | AWS region. |
Methods
Name | Accessible by | Required Params |
---|---|---|
list_resources | SELECT | region |
SELECT
examples
Lists all domains
in a region.
SELECT
region,
domain_name
FROM aws.customerprofiles.domains_list_only
WHERE region = 'us-east-1';
Permissions
For permissions required to operate on the domains_list_only
resource, see domains