similar_profiles
Creates, updates, deletes, gets or lists a similar_profiles resource.
Overview
| Name | similar_profiles |
| Type | Resource |
| Id | aws.customer_profiles.similar_profiles |
Fields
The following fields are returned by SELECT queries:
- get_similar_profiles
| Name | Datatype | Description |
|---|---|---|
profile_id | string | Set of profileIds that belong to the same matching group. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_similar_profiles | select | domain_name, region | next-token, max-results | Returns a set of profiles that belong to the same matching group using the matchId or profileId. You can also specify the type of matching that you want for finding similar profiles using either RULE_BASED_MATCHING or ML_BASED_MATCHING. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
domain_name | string | The unique name of the domain. |
region | string | AWS region (default: us-east-1) |
max-results | integer | The maximum number of objects returned per page. |
next-token | string | The pagination token from the previous GetSimilarProfiles API call. |
SELECT examples
- get_similar_profiles
Returns a set of profiles that belong to the same matching group using the matchId or profileId. You can also specify the type of matching that you want for finding similar profiles using either RULE_BASED_MATCHING or ML_BASED_MATCHING.
SELECT
profile_id
FROM aws.customer_profiles.similar_profiles
WHERE domain_name = '{{ domain_name }}' -- required
AND region = '{{ region }}' -- required
AND `next-token` = '{{ next-token }}'
AND `max-results` = '{{ max-results }}'
;