Aws/customerprofiles
@swamp/aws/customerprofilesv2026.10.25.1
01README
AWS CUSTOMERPROFILES infrastructure models
02Release Notes
- Updated: calculated_attribute_definition, recommender
03Behaviors
@swamp/aws/customerprofiles/calculated-attribute-definitionv2026.10.25.1calculated_attribute_definition.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| DomainName | string | The unique name of the domain. |
| CalculatedAttributeName | string | The unique name of the calculated attribute. |
| DisplayName? | string | The display name of the calculated attribute. |
| Description? | string | The description of the calculated attribute. |
| AttributeDetails | object | Mathematical expression and a list of attribute items specified in that expression. |
| Conditions? | object | The conditions including range, object count, and threshold for the calculated attribute. |
| Statistic | enum | The aggregation operation to perform for the calculated attribute. |
| UseHistoricalData? | boolean | Whether to use historical data for the calculated attribute. |
| Readiness? | object | The readiness status of the calculated attribute. |
| Tags? | array | An array of key-value pairs to apply to this resource. |
fn create()
Create a CustomerProfiles CalculatedAttributeDefinition
fn get(identifier: string)
Get a CustomerProfiles CalculatedAttributeDefinition
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the CustomerProfiles CalculatedAttributeDefinition |
fn update()
Update a CustomerProfiles CalculatedAttributeDefinition
fn delete(identifier: string)
Delete a CustomerProfiles CalculatedAttributeDefinition
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the CustomerProfiles CalculatedAttributeDefinition |
fn sync()
Sync CustomerProfiles CalculatedAttributeDefinition state from AWS
fn list(maxPages?: number, resourceModel?: string)
List CustomerProfiles CalculatedAttributeDefinition resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— CustomerProfiles CalculatedAttributeDefinition resource state
@swamp/aws/customerprofiles/domainv2026.10.23.1domain.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| DomainName | string | The unique name of the domain. |
| DeadLetterQueueUrl? | string | The URL of the SQS dead letter queue |
| DefaultEncryptionKey? | string | The default encryption key |
| DefaultExpirationDays | number | 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 ca |
| RuleBasedMatching? | 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. |
| DataStore? | object | Configuration and status of the data store for the domain. |
| Stats? | object | Usage-specific statistics about the domain. |
| Tags? | array | The tags (keys and values) associated with the domain |
fn create()
Create a CustomerProfiles Domain
fn get(identifier: string)
Get a CustomerProfiles Domain
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the CustomerProfiles Domain |
fn update()
Update a CustomerProfiles Domain
fn delete(identifier: string)
Delete a CustomerProfiles Domain
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the CustomerProfiles Domain |
fn sync()
Sync CustomerProfiles Domain state from AWS
fn list(maxPages?: number, resourceModel?: string)
List CustomerProfiles Domain resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— CustomerProfiles Domain resource state
@swamp/aws/customerprofiles/domain-object-typev2026.10.23.1domain_object_type.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| DomainName | string | The unique name of the domain. |
| ObjectTypeName | string | The name of the domain object type. |
| Description? | string | Description of the domain object type. |
| EncryptionKey? | string | The default encryption key |
| Fields | record | A map of the name and ObjectType field. |
| Tags? | array | An array of key-value pairs to apply to this resource. |
fn create()
Create a CustomerProfiles DomainObjectType
fn get(identifier: string)
Get a CustomerProfiles DomainObjectType
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the CustomerProfiles DomainObjectType |
fn update()
Update a CustomerProfiles DomainObjectType
fn delete(identifier: string)
Delete a CustomerProfiles DomainObjectType
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the CustomerProfiles DomainObjectType |
fn sync()
Sync CustomerProfiles DomainObjectType state from AWS
fn list(maxPages?: number, resourceModel?: string)
List CustomerProfiles DomainObjectType resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— CustomerProfiles DomainObjectType resource state
@swamp/aws/customerprofiles/event-streamv2026.10.23.1event_stream.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| DomainName | string | The unique name of the domain. |
| EventStreamName | string | The name of the event stream. |
| Uri | string | The StreamARN of the destination to deliver profile events to. For example, arn:aws:kinesis:region:account-id:stream/stream-name |
| Tags? | array | The tags used to organize, track, or control access for this resource. |
| DestinationDetails? | object | Details regarding the Kinesis stream. |
fn create()
Create a CustomerProfiles EventStream
fn get(identifier: string)
Get a CustomerProfiles EventStream
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the CustomerProfiles EventStream |
fn update()
Update a CustomerProfiles EventStream
fn delete(identifier: string)
Delete a CustomerProfiles EventStream
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the CustomerProfiles EventStream |
fn sync()
Sync CustomerProfiles EventStream state from AWS
fn list(maxPages?: number, resourceModel?: string)
List CustomerProfiles EventStream resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— CustomerProfiles EventStream resource state
@swamp/aws/customerprofiles/event-triggerv2026.10.23.1event_trigger.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| DomainName | string | The unique name of the domain. |
| EventTriggerName | string | The unique name of the event trigger. |
| ObjectTypeName | string | The unique name of the object type. |
| Description? | string | The description of the event trigger. |
| EventTriggerConditions | array | A list of conditions that determine when an event should trigger the destination. |
| EventTriggerLimits? | object | Defines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods. |
| SegmentFilter? | string | The destination is triggered only for profiles that meet the criteria of a segment definition. |
| Tags? | array | An array of key-value pairs to apply to this resource. |
fn create()
Create a CustomerProfiles EventTrigger
fn get(identifier: string)
Get a CustomerProfiles EventTrigger
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the CustomerProfiles EventTrigger |
fn update()
Update a CustomerProfiles EventTrigger
fn delete(identifier: string)
Delete a CustomerProfiles EventTrigger
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the CustomerProfiles EventTrigger |
fn sync()
Sync CustomerProfiles EventTrigger state from AWS
fn list(maxPages?: number, resourceModel?: string)
List CustomerProfiles EventTrigger resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— CustomerProfiles EventTrigger resource state
@swamp/aws/customerprofiles/integrationv2026.10.23.1integration.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| DomainName | string | The unique name of the domain. |
| Uri? | string | The URI of the S3 bucket or any other type of data source. |
| FlowDefinition? | object | |
| ObjectTypeName? | string | The name of the ObjectType defined for the 3rd party data in Profile Service |
| Tags? | array | The tags (keys and values) associated with the integration |
| ObjectTypeNames? | array | The mapping between 3rd party event types and ObjectType names |
| EventTriggerNames? | array | A list of unique names for active event triggers associated with the integration. |
| Scope? | enum | Scope of the integration, such as 'PROFILE' or 'DOMAIN' |
fn create()
Create a CustomerProfiles Integration
fn get(identifier: string)
Get a CustomerProfiles Integration
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the CustomerProfiles Integration |
fn update()
Update a CustomerProfiles Integration
fn delete(identifier: string)
Delete a CustomerProfiles Integration
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the CustomerProfiles Integration |
fn sync()
Sync CustomerProfiles Integration state from AWS
fn list(maxPages?: number, resourceModel?: string)
List CustomerProfiles Integration resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— CustomerProfiles Integration resource state
@swamp/aws/customerprofiles/object-typev2026.10.23.1object_type.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| DomainName | string | The unique name of the domain. |
| ObjectTypeName | string | The name of the profile object type. |
| AllowProfileCreation? | boolean | Indicates whether a profile should be created when data is received. |
| Description | string | Description of the profile object type. |
| EncryptionKey? | string | The default encryption key |
| ExpirationDays? | number | The default number of days until the data within the domain expires. |
| Fields? | array | A list of the name and ObjectType field. |
| Keys? | array | A list of unique keys that can be used to map data to the profile. |
| SourceLastUpdatedTimestampFormat? | string | The format of your sourceLastUpdatedTimestamp that was previously set up. |
| Tags? | array | The tags (keys and values) associated with the integration. |
| TemplateId? | string | A unique identifier for the object template. |
| MaxProfileObjectCount? | number | The maximum number of profile objects for this object type |
| SourcePriority? | number | Defines the priority order of object types. Lower value indicates higher priority. |
fn create()
Create a CustomerProfiles ObjectType
fn get(identifier: string)
Get a CustomerProfiles ObjectType
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the CustomerProfiles ObjectType |
fn update()
Update a CustomerProfiles ObjectType
fn delete(identifier: string)
Delete a CustomerProfiles ObjectType
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the CustomerProfiles ObjectType |
fn sync()
Sync CustomerProfiles ObjectType state from AWS
fn list(maxPages?: number, resourceModel?: string)
List CustomerProfiles ObjectType resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— CustomerProfiles ObjectType resource state
@swamp/aws/customerprofiles/recommenderv2026.10.25.1recommender.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| DomainName | string | The name of the domain for which the recommender will be created |
| RecommenderName | string | The name of the recommender |
| RecommenderRecipeName | string | The name of the recommender recipe. |
| RecommenderConfig? | object | Configuration for the recommender |
| Description? | string | The description of the recommender. |
| LatestRecommenderUpdate? | object | Information about the latest recommender update |
| Tags? | array | The tags used to organize, track, or control access for this resource. |
fn create()
Create a CustomerProfiles Recommender
fn get(identifier: string)
Get a CustomerProfiles Recommender
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the CustomerProfiles Recommender |
fn update()
Update a CustomerProfiles Recommender
fn delete(identifier: string)
Delete a CustomerProfiles Recommender
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the CustomerProfiles Recommender |
fn sync()
Sync CustomerProfiles Recommender state from AWS
fn list(maxPages?: number, resourceModel?: string)
List CustomerProfiles Recommender resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— CustomerProfiles Recommender resource state
@swamp/aws/customerprofiles/recommender-filterv2026.10.23.1recommender_filter.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| DomainName | string | The unique name of the domain. |
| RecommenderFilterName | string | The name of the recommender filter. |
| RecommenderFilterExpression | string | The filter expression that defines which items to include or exclude from recommendations. |
| RecommenderSchemaName? | string | The name of the recommender schema to use for this recommender filter. If not specified, the default schema is used. |
| Description? | string | The description of the recommender filter. |
| Tags? | array | The tags used to organize, track, or control access for this resource. |
fn create()
Create a CustomerProfiles RecommenderFilter
fn get(identifier: string)
Get a CustomerProfiles RecommenderFilter
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the CustomerProfiles RecommenderFilter |
fn update()
Update a CustomerProfiles RecommenderFilter
fn delete(identifier: string)
Delete a CustomerProfiles RecommenderFilter
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the CustomerProfiles RecommenderFilter |
fn sync()
Sync CustomerProfiles RecommenderFilter state from AWS
fn list(maxPages?: number, resourceModel?: string)
List CustomerProfiles RecommenderFilter resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— CustomerProfiles RecommenderFilter resource state
@swamp/aws/customerprofiles/recommender-schemav2026.10.23.1recommender_schema.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| DomainName | string | |
| RecommenderSchemaName | string | |
| Fields | record | |
| Tags? | array |
fn create()
Create a CustomerProfiles RecommenderSchema
fn get(identifier: string)
Get a CustomerProfiles RecommenderSchema
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the CustomerProfiles RecommenderSchema |
fn update()
Update a CustomerProfiles RecommenderSchema
fn delete(identifier: string)
Delete a CustomerProfiles RecommenderSchema
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the CustomerProfiles RecommenderSchema |
fn sync()
Sync CustomerProfiles RecommenderSchema state from AWS
fn list(maxPages?: number, resourceModel?: string)
List CustomerProfiles RecommenderSchema resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— CustomerProfiles RecommenderSchema resource state
@swamp/aws/customerprofiles/segment-definitionv2026.10.23.1segment_definition.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Description? | string | The description of the segment definition. |
| DisplayName | string | The display name of the segment definition. |
| DomainName | string | The unique name of the domain. |
| SegmentDefinitionName | string | The unique name of the segment definition. |
| SegmentGroups? | object | An array that defines the set of segment criteria to evaluate when handling segment groups for the segment. |
| SegmentSqlQuery? | string | The SQL query that defines the segment criteria. |
| Tags? | array | The tags used to organize, track, or control access for this resource. |
| SegmentSort? | object | The segment sort configuration for ordering segment results. |
fn create()
Create a CustomerProfiles SegmentDefinition
fn get(identifier: string)
Get a CustomerProfiles SegmentDefinition
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the CustomerProfiles SegmentDefinition |
fn update()
Update a CustomerProfiles SegmentDefinition
fn delete(identifier: string)
Delete a CustomerProfiles SegmentDefinition
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the CustomerProfiles SegmentDefinition |
fn sync()
Sync CustomerProfiles SegmentDefinition state from AWS
fn list(maxPages?: number, resourceModel?: string)
List CustomerProfiles SegmentDefinition resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— CustomerProfiles SegmentDefinition resource state
04Previous Versions
2026.10.24.1AGPL-3.0-or-later
2026.10.23.1AGPL-3.0-or-later
- Updated: calculated_attribute_definition, domain, domain_object_type, event_stream, event_trigger, integration, object_type, recommender, recommender_filter, recommender_schema, segment_definition
2026.10.15.1AGPL-3.0-or-later(was none)
- Added: recommender_filter
Added 1 behaviors
2026.10.13.1
- Updated: calculated_attribute_definition, domain, domain_object_type, event_stream, event_trigger, integration, object_type, recommender, recommender_schema, segment_definition
2026.10.08.1
2026.10.06.1
2026.10.04.1
2026.10.03.1
2026.10.02.1
2026.10.01.1
2026.09.30.1
2026.09.29.1
2026.09.28.1
2026.09.27.1
2026.09.26.1
2026.09.25.1
2026.09.24.1
- Added: recommender_schema
Added 1 behaviors
2026.09.23.1
2026.09.21.1
05Stats
A
100 / 100
Downloads
119
Archive size
2.2 MB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Docs keep secrets in a vault1/1earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License2/2earned
- Verified public repository2/2earned
06Platforms
07Labels