Skip to content
AWS for Query.Farm

aws.customer_profiles.get_domain

Example SQL Queries

SELECT * FROM
aws.customer_profiles.get_domain
WHERE
"domain_name" = 'VALUE';

Description

Returns information about a specific domain.

Table Definition

Column NameColumn Data Type
domain_name Required Input Column

The unique name of the domain.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

created_at

The timestamp of when the domain was created.

TIMESTAMP_S
dead_letter_queue_url

The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.

VARCHAR
default_encryption_key

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.

VARCHAR
default_expiration_days

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

BIGINT
last_updated_at

The timestamp of when the domain was most recently edited.

TIMESTAMP_S
matching

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.

STRUCT(
    "enabled" BOOLEAN,
    "job_schedule" STRUCT(
        "day_of_the_week" VARCHAR,
        "time" VARCHAR
    ),
    "auto_merging" STRUCT(
        "enabled" BOOLEAN,
        "consolidation" STRUCT(
            "matching_attributes_list" VARCHAR[][]
        ),
        "conflict_resolution" STRUCT(
            "conflict_resolving_model" VARCHAR,
            "source_name" VARCHAR
        ),
        "min_allowed_confidence_score_for_merging" DOUBLE
    ),
    "exporting_config" STRUCT(
        "s3_exporting" STRUCT(
            "s3_bucket_name" VARCHAR,
            "s3_key_name" VARCHAR
        )
    )
)
Show child fields
matching.auto_merging

Configuration information about the auto-merging process.

Show child fields
matching.auto_merging.conflict_resolution

How the auto-merging process should resolve conflicts between different profiles. For example, if Profile A and Profile B have the same FirstName and LastName (and that is the matching criteria), which EmailAddress should be used?

Show child fields
matching.auto_merging.conflict_resolution.conflict_resolving_model

How the auto-merging process should resolve conflicts between different profiles.

  • RECENCY: Uses the data that was most recently updated.

  • SOURCE: Uses the data from a specific source. For example, if a company has been aquired or two departments have merged, data from the specified source is used. If two duplicate profiles are from the same source, then RECENCY is used again.

matching.auto_merging.conflict_resolution.source_name

The ObjectType name that is used to resolve profile merging conflicts when choosing SOURCE as the ConflictResolvingModel.

matching.auto_merging.consolidation

A list of matching attributes that represent matching criteria. If two profiles meet at least one of the requirements in the matching attributes list, they will be merged.

Show child fields
matching.auto_merging.consolidation.matching_attributes_list[][]
matching.auto_merging.enabled

The flag that enables the auto-merging of duplicate profiles.

matching.auto_merging.min_allowed_confidence_score_for_merging

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.

matching.enabled

The flag that enables the matching process of duplicate profiles.

matching.exporting_config

Configuration information for exporting Identity Resolution results, for example, to an S3 bucket.

Show child fields
matching.exporting_config.s3_exporting

The S3 location where Identity Resolution Jobs write result files.

Show child fields
matching.exporting_config.s3_exporting.s3_bucket_name

The name of the S3 bucket where Identity Resolution Jobs write result files.

matching.exporting_config.s3_exporting.s3_key_name

The S3 key name of the location where Identity Resolution Jobs write result files.

matching.job_schedule

The day and time when do you want to start the Identity Resolution Job every week.

Show child fields
matching.job_schedule.day_of_the_week

The day when the Identity Resolution Job should run every week.

matching.job_schedule.time

The time when the Identity Resolution Job should run every week.

rule_based_matching

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.

STRUCT(
    "enabled" BOOLEAN,
    "matching_rules" STRUCT(
        "rule" VARCHAR[]
    )[],
    "status" VARCHAR,
    "max_allowed_rule_level_for_merging" BIGINT,
    "max_allowed_rule_level_for_matching" BIGINT,
    "attribute_types_selector" STRUCT(
        "attribute_matching_model" VARCHAR,
        "address" VARCHAR[],
        "phone_number" VARCHAR[],
        "email_address" VARCHAR[]
    ),
    "conflict_resolution" STRUCT(
        "conflict_resolving_model" VARCHAR,
        "source_name" VARCHAR
    ),
    "exporting_config" STRUCT(
        "s3_exporting" STRUCT(
            "s3_bucket_name" VARCHAR,
            "s3_key_name" VARCHAR
        )
    )
)
Show child fields
rule_based_matching.attribute_types_selector

Configures information about the AttributeTypesSelector where the rule-based identity resolution uses to match profiles.

Show child fields
rule_based_matching.attribute_types_selector.address[]
rule_based_matching.attribute_types_selector.attribute_matching_model

Configures the AttributeMatchingModel, you can either choose ONE_TO_ONE or MANY_TO_MANY.

rule_based_matching.attribute_types_selector.email_address[]
rule_based_matching.attribute_types_selector.phone_number[]
rule_based_matching.conflict_resolution

How the auto-merging process should resolve conflicts between different profiles.

Show child fields
rule_based_matching.conflict_resolution.conflict_resolving_model

How the auto-merging process should resolve conflicts between different profiles.

  • RECENCY: Uses the data that was most recently updated.

  • SOURCE: Uses the data from a specific source. For example, if a company has been aquired or two departments have merged, data from the specified source is used. If two duplicate profiles are from the same source, then RECENCY is used again.

rule_based_matching.conflict_resolution.source_name

The ObjectType name that is used to resolve profile merging conflicts when choosing SOURCE as the ConflictResolvingModel.

rule_based_matching.enabled

The flag that enables the rule-based matching process of duplicate profiles.

rule_based_matching.exporting_config

Configuration information about the S3 bucket where Identity Resolution Jobs writes result files.

You need to give Customer Profiles service principal write permission to your S3 bucket. Otherwise, you'll get an exception in the API response. For an example policy, see Amazon Connect Customer Profiles cross-service confused deputy prevention.

Show child fields
rule_based_matching.exporting_config.s3_exporting

The S3 location where Identity Resolution Jobs write result files.

Show child fields
rule_based_matching.exporting_config.s3_exporting.s3_bucket_name

The name of the S3 bucket where Identity Resolution Jobs write result files.

rule_based_matching.exporting_config.s3_exporting.s3_key_name

The S3 key name of the location where Identity Resolution Jobs write result files.

rule_based_matching.matching_rules[]
Show child fields
rule_based_matching.matching_rules[].rule[]
rule_based_matching.max_allowed_rule_level_for_matching

Indicates the maximum allowed rule level.

rule_based_matching.max_allowed_rule_level_for_merging

MatchingRule

rule_based_matching.status

PENDING

  • The first status after configuration a rule-based matching rule. If it is an existing domain, the rule-based Identity Resolution waits one hour before creating the matching rule. If it is a new domain, the system will skip the PENDING stage.

IN_PROGRESS

  • The system is creating the rule-based matching rule. Under this status, the system is evaluating the existing data and you can no longer change the Rule-based matching configuration.

ACTIVE

  • The rule is ready to use. You can change the rule a day after the status is in ACTIVE.

stats

Usage-specific statistics about the domain.

STRUCT(
    "profile_count" BIGINT,
    "metering_profile_count" BIGINT,
    "object_count" BIGINT,
    "total_size" BIGINT
)
Show child fields
stats.metering_profile_count

The number of profiles that you are currently paying for in the domain. If you have more than 100 objects associated with a single profile, that profile counts as two profiles. If you have more than 200 objects, that profile counts as three, and so on.

stats.object_count

The total number of objects in domain.

stats.profile_count

The total number of profiles currently in the domain.

stats.total_size

The total size, in bytes, of all objects in the domain.

tags

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

MAP(VARCHAR, VARCHAR)