Skip to main content
← back to extensions

@swamp/aws/customerprofiles

v2026.04.23.3

AWS CUSTOMERPROFILES infrastructure models

Repository

https://github.com/systeminit/swamp-extensions

Platforms

linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64

Labels

awscustomerprofilescloudinfrastructure

Contents

models

Quality score

Verified by Swamp

How well-documented and verifiable this extension is.

100%

Grade A

  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types1/1earned
  • Has description1/1earned
  • At least one platform tag (or universal)1/1earned
  • Two or more platform tags (or universal)1/1earned
  • License declared1/1earned
  • Verified public repository2/2earned

Install

$ swamp extension pull @swamp/aws/customerprofiles

@swamp/aws/customerprofiles/calculated-attribute-definitionv2026.04.23.2calculated_attribute_definition.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
DomainNamestringThe unique name of the domain.
CalculatedAttributeNamestringThe unique name of the calculated attribute.
DisplayName?stringThe display name of the calculated attribute.
Description?stringThe description of the calculated attribute.
AttributeDetailsobjectMathematical expression and a list of attribute items specified in that expression.
Conditions?objectThe conditions including range, object count, and threshold for the calculated attribute.
StatisticenumThe aggregation operation to perform for the calculated attribute.
UseHistoricalData?booleanWhether to use historical data for the calculated attribute.
Readiness?objectThe readiness status of the calculated attribute.
Tags?arrayAn array of key-value pairs to apply to this resource.
createCreate a CustomerProfiles CalculatedAttributeDefinition
getGet a CustomerProfiles CalculatedAttributeDefinition
ArgumentTypeDescription
identifierstringThe primary identifier of the CustomerProfiles CalculatedAttributeDefinition
updateUpdate a CustomerProfiles CalculatedAttributeDefinition
deleteDelete a CustomerProfiles CalculatedAttributeDefinition
ArgumentTypeDescription
identifierstringThe primary identifier of the CustomerProfiles CalculatedAttributeDefinition
syncSync CustomerProfiles CalculatedAttributeDefinition state from AWS

Resources

state(infinite)— CustomerProfiles CalculatedAttributeDefinition resource state
@swamp/aws/customerprofiles/domainv2026.04.23.2domain.ts

Global Arguments

ArgumentTypeDescription
DomainNamestringThe unique name of the domain.
DeadLetterQueueUrl?stringThe URL of the SQS dead letter queue
DefaultEncryptionKey?stringThe default encryption key
DefaultExpirationDaysnumberThe default number of days until the data within the domain expires.
Matching?objectThe 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 ca
RuleBasedMatching?objectThe 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.
DataStore?objectConfiguration and status of the data store for the domain.
Stats?objectUsage-specific statistics about the domain.
Tags?arrayThe tags (keys and values) associated with the domain
createCreate a CustomerProfiles Domain
getGet a CustomerProfiles Domain
ArgumentTypeDescription
identifierstringThe primary identifier of the CustomerProfiles Domain
updateUpdate a CustomerProfiles Domain
deleteDelete a CustomerProfiles Domain
ArgumentTypeDescription
identifierstringThe primary identifier of the CustomerProfiles Domain
syncSync CustomerProfiles Domain state from AWS

Resources

state(infinite)— CustomerProfiles Domain resource state
@swamp/aws/customerprofiles/event-streamv2026.04.23.2event_stream.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
DomainNamestringThe unique name of the domain.
EventStreamNamestringThe name of the event stream.
UristringThe StreamARN of the destination to deliver profile events to. For example, arn:aws:kinesis:region:account-id:stream/stream-name
Tags?arrayThe tags used to organize, track, or control access for this resource.
DestinationDetails?objectDetails regarding the Kinesis stream.
createCreate a CustomerProfiles EventStream
getGet a CustomerProfiles EventStream
ArgumentTypeDescription
identifierstringThe primary identifier of the CustomerProfiles EventStream
updateUpdate a CustomerProfiles EventStream
deleteDelete a CustomerProfiles EventStream
ArgumentTypeDescription
identifierstringThe primary identifier of the CustomerProfiles EventStream
syncSync CustomerProfiles EventStream state from AWS

Resources

state(infinite)— CustomerProfiles EventStream resource state
@swamp/aws/customerprofiles/event-triggerv2026.04.23.2event_trigger.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
DomainNamestringThe unique name of the domain.
EventTriggerNamestringThe unique name of the event trigger.
ObjectTypeNamestringThe unique name of the object type.
Description?stringThe description of the event trigger.
EventTriggerConditionsarrayA list of conditions that determine when an event should trigger the destination.
EventTriggerLimits?objectDefines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods.
SegmentFilter?stringThe destination is triggered only for profiles that meet the criteria of a segment definition.
Tags?arrayAn array of key-value pairs to apply to this resource.
createCreate a CustomerProfiles EventTrigger
getGet a CustomerProfiles EventTrigger
ArgumentTypeDescription
identifierstringThe primary identifier of the CustomerProfiles EventTrigger
updateUpdate a CustomerProfiles EventTrigger
deleteDelete a CustomerProfiles EventTrigger
ArgumentTypeDescription
identifierstringThe primary identifier of the CustomerProfiles EventTrigger
syncSync CustomerProfiles EventTrigger state from AWS

Resources

state(infinite)— CustomerProfiles EventTrigger resource state
@swamp/aws/customerprofiles/integrationv2026.04.23.2integration.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
DomainNamestringThe unique name of the domain.
Uri?stringThe URI of the S3 bucket or any other type of data source.
FlowDefinition?object
ObjectTypeName?stringThe name of the ObjectType defined for the 3rd party data in Profile Service
Tags?arrayThe tags (keys and values) associated with the integration
ObjectTypeNames?arrayThe mapping between 3rd party event types and ObjectType names
EventTriggerNames?arrayA list of unique names for active event triggers associated with the integration.
Scope?enumScope of the integration, such as 'PROFILE' or 'DOMAIN'
createCreate a CustomerProfiles Integration
getGet a CustomerProfiles Integration
ArgumentTypeDescription
identifierstringThe primary identifier of the CustomerProfiles Integration
updateUpdate a CustomerProfiles Integration
deleteDelete a CustomerProfiles Integration
ArgumentTypeDescription
identifierstringThe primary identifier of the CustomerProfiles Integration
syncSync CustomerProfiles Integration state from AWS

Resources

state(infinite)— CustomerProfiles Integration resource state
@swamp/aws/customerprofiles/object-typev2026.04.23.2object_type.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
DomainNamestringThe unique name of the domain.
ObjectTypeNamestringThe name of the profile object type.
AllowProfileCreation?booleanIndicates whether a profile should be created when data is received.
DescriptionstringDescription of the profile object type.
EncryptionKey?stringThe default encryption key
ExpirationDays?numberThe default number of days until the data within the domain expires.
Fields?arrayA list of the name and ObjectType field.
Keys?arrayA list of unique keys that can be used to map data to the profile.
SourceLastUpdatedTimestampFormat?stringThe format of your sourceLastUpdatedTimestamp that was previously set up.
Tags?arrayThe tags (keys and values) associated with the integration.
TemplateId?stringA unique identifier for the object template.
MaxProfileObjectCount?numberThe maximum number of profile objects for this object type
SourcePriority?numberDefines the priority order of object types. Lower value indicates higher priority.
createCreate a CustomerProfiles ObjectType
getGet a CustomerProfiles ObjectType
ArgumentTypeDescription
identifierstringThe primary identifier of the CustomerProfiles ObjectType
updateUpdate a CustomerProfiles ObjectType
deleteDelete a CustomerProfiles ObjectType
ArgumentTypeDescription
identifierstringThe primary identifier of the CustomerProfiles ObjectType
syncSync CustomerProfiles ObjectType state from AWS

Resources

state(infinite)— CustomerProfiles ObjectType resource state
@swamp/aws/customerprofiles/recommenderv2026.04.23.2recommender.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
DomainNamestringThe name of the domain for which the recommender will be created
RecommenderNamestringThe name of the recommender
RecommenderRecipeNamestringThe name of the recommender recipe.
RecommenderConfig?objectConfiguration for the recommender
Description?stringThe description of the recommender.
LatestRecommenderUpdate?objectInformation about the latest recommender update
Tags?arrayThe tags used to organize, track, or control access for this resource.
createCreate a CustomerProfiles Recommender
getGet a CustomerProfiles Recommender
ArgumentTypeDescription
identifierstringThe primary identifier of the CustomerProfiles Recommender
updateUpdate a CustomerProfiles Recommender
deleteDelete a CustomerProfiles Recommender
ArgumentTypeDescription
identifierstringThe primary identifier of the CustomerProfiles Recommender
syncSync CustomerProfiles Recommender state from AWS

Resources

state(infinite)— CustomerProfiles Recommender resource state
@swamp/aws/customerprofiles/segment-definitionv2026.04.23.2segment_definition.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
Description?stringThe description of the segment definition.
DisplayNamestringThe display name of the segment definition.
DomainNamestringThe unique name of the domain.
SegmentDefinitionNamestringThe unique name of the segment definition.
SegmentGroups?objectAn array that defines the set of segment criteria to evaluate when handling segment groups for the segment.
SegmentSqlQuery?stringThe SQL query that defines the segment criteria.
Tags?arrayThe tags used to organize, track, or control access for this resource.
SegmentSort?objectThe segment sort configuration for ordering segment results.
createCreate a CustomerProfiles SegmentDefinition
getGet a CustomerProfiles SegmentDefinition
ArgumentTypeDescription
identifierstringThe primary identifier of the CustomerProfiles SegmentDefinition
updateUpdate a CustomerProfiles SegmentDefinition
deleteDelete a CustomerProfiles SegmentDefinition
ArgumentTypeDescription
identifierstringThe primary identifier of the CustomerProfiles SegmentDefinition
syncSync CustomerProfiles SegmentDefinition state from AWS

Resources

state(infinite)— CustomerProfiles SegmentDefinition resource state