Aws/personalize
@swamp/aws/personalizev2026.10.25.1
01README
AWS PERSONALIZE infrastructure models
02Release Notes
- Updated: dataset
03Behaviors
@swamp/aws/personalize/campaignv2026.10.23.1campaign.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. |
| Name | string | The name of the campaign. |
| SolutionVersionArn | string | The ARN of the solution version to deploy. |
| MinProvisionedTPS? | number | Specifies the requested minimum provisioned transactions per second. |
| CampaignConfig? | object | The configuration details of a campaign. |
| Tags? | array | Tags to associate with the campaign. |
fn create()
Create a Personalize Campaign
fn get(identifier: string)
Get a Personalize Campaign
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Personalize Campaign |
fn update()
Update a Personalize Campaign
fn delete(identifier: string)
Delete a Personalize Campaign
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Personalize Campaign |
fn sync()
Sync Personalize Campaign state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Personalize Campaign 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)— Personalize Campaign resource state
@swamp/aws/personalize/datasetv2026.10.25.1dataset.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. |
| Name | string | The name for the dataset |
| DatasetType | enum | The type of dataset |
| DatasetGroupArn | string | The Amazon Resource Name (ARN) of the dataset group to add the dataset to |
| SchemaArn | string | The ARN of the schema to associate with the dataset. The schema defines the dataset fields. |
| DatasetImportJob? | object | Initial DatasetImportJob for the created dataset |
| Tags? | array | The tags used to organize, track, or control access for this resource. |
fn create()
Create a Personalize Dataset
fn get(identifier: string)
Get a Personalize Dataset
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Personalize Dataset |
fn update()
Update a Personalize Dataset
fn delete(identifier: string)
Delete a Personalize Dataset
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Personalize Dataset |
fn sync()
Sync Personalize Dataset state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Personalize Dataset 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)— Personalize Dataset resource state
@swamp/aws/personalize/dataset-groupv2026.10.23.1dataset_group.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. |
| Name | string | The name for the new dataset group. |
| KmsKeyArn? | string | The Amazon Resource Name(ARN) of a AWS Key Management Service (KMS) key used to encrypt the datasets. |
| RoleArn? | string | The ARN of the AWS Identity and Access Management (IAM) role that has permissions to access the AWS Key Management Service (KMS) key. Supplying an IAM role is only valid when also specifying a KMS key. |
| Domain? | enum | The domain of a Domain dataset group. |
| Tags? | array | The tags used to organize, track, or control access for this resource. |
fn create()
Create a Personalize DatasetGroup
fn get(identifier: string)
Get a Personalize DatasetGroup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Personalize DatasetGroup |
fn delete(identifier: string)
Delete a Personalize DatasetGroup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Personalize DatasetGroup |
fn sync()
Sync Personalize DatasetGroup state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Personalize DatasetGroup 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)— Personalize DatasetGroup resource state
@swamp/aws/personalize/event-trackerv2026.10.23.1event_tracker.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. |
| Name | string | The name for the event tracker. |
| DatasetGroupArn | string | The Amazon Resource Name (ARN) of the dataset group that receives the event data. |
| Tags? | array | A list of tags to apply to the event tracker. |
fn create()
Create a Personalize EventTracker
fn get(identifier: string)
Get a Personalize EventTracker
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Personalize EventTracker |
fn update()
Update a Personalize EventTracker
fn delete(identifier: string)
Delete a Personalize EventTracker
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Personalize EventTracker |
fn sync()
Sync Personalize EventTracker state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Personalize EventTracker 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)— Personalize EventTracker resource state
@swamp/aws/personalize/filterv2026.10.23.1filter.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. |
| Name | string | The name of the filter. |
| DatasetGroupArn | string | The ARN of the dataset group that the filter belongs to. |
| FilterExpression | string | The filter expression that defines which items are included or excluded from recommendations. |
| Tags? | array | Tags to associate with the filter. |
fn create()
Create a Personalize Filter
fn get(identifier: string)
Get a Personalize Filter
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Personalize Filter |
fn update()
Update a Personalize Filter
fn delete(identifier: string)
Delete a Personalize Filter
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Personalize Filter |
fn sync()
Sync Personalize Filter state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Personalize Filter 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)— Personalize Filter resource state
@swamp/aws/personalize/metric-attributionv2026.10.23.1metric_attribution.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. |
| Name | string | The name of the metric attribution. |
| DatasetGroupArn | string | The ARN of the destination dataset group. |
| Metrics | array | A list of metric attributes for the metric attribution. |
| MetricsOutputConfig | object | The output configuration details for the metric attribution. |
fn create()
Create a Personalize MetricAttribution
fn get(identifier: string)
Get a Personalize MetricAttribution
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Personalize MetricAttribution |
fn update()
Update a Personalize MetricAttribution
fn delete(identifier: string)
Delete a Personalize MetricAttribution
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Personalize MetricAttribution |
fn sync()
Sync Personalize MetricAttribution state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Personalize MetricAttribution 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)— Personalize MetricAttribution resource state
@swamp/aws/personalize/schemav2026.10.23.1schema.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. |
| Name | string | Name for the schema. |
| Schema | string | A schema in Avro JSON format. |
| Domain? | enum | The domain of a Domain dataset group. |
| Tags? | array | The tags used to organize, track, or control access for this resource. |
fn create()
Create a Personalize Schema
fn get(identifier: string)
Get a Personalize Schema
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Personalize Schema |
fn delete(identifier: string)
Delete a Personalize Schema
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Personalize Schema |
fn sync()
Sync Personalize Schema state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Personalize Schema 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)— Personalize Schema resource state
@swamp/aws/personalize/solutionv2026.10.23.1solution.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. |
| Name | string | The name for the solution |
| EventType? | string | When your have multiple event types (using an EVENT_TYPE schema field), this parameter specifies which event type (for example, 'click' or 'like') is used for training the model. If you do not provide an eventType, Amazon Personalize will use all interactions for training with equal weight regardless of type. |
| DatasetGroupArn | string | The ARN of the dataset group that provides the training data. |
| PerformAutoML? | boolean | Whether to perform automated machine learning (AutoML). The default is false. For this case, you must specify recipeArn. |
| PerformHPO? | boolean | Whether to perform hyperparameter optimization (HPO) on the specified or selected recipe. The default is false. When performing AutoML, this parameter is always true and you should not set it to false. |
| RecipeArn? | string | The ARN of the recipe to use for model training. Only specified when performAutoML is false. |
| SolutionConfig? | object | The configuration to use with the solution. When performAutoML is set to true, Amazon Personalize only evaluates the autoMLConfig section of the solution configuration. |
| Tags? | array | The tags used to organize, track, or control access for this resource. |
fn create()
Create a Personalize Solution
fn get(identifier: string)
Get a Personalize Solution
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Personalize Solution |
fn delete(identifier: string)
Delete a Personalize Solution
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Personalize Solution |
fn sync()
Sync Personalize Solution state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Personalize Solution 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)— Personalize Solution resource state
04Previous Versions
2026.10.24.1AGPL-3.0-or-later
2026.10.23.1AGPL-3.0-or-later(was none)
- Updated: campaign, dataset, dataset_group, event_tracker, filter, metric_attribution, schema, solution
2026.10.13.1
- Updated: campaign, dataset, dataset_group, event_tracker, filter, metric_attribution, schema, solution
2026.10.08.1
2026.10.06.1
2026.10.04.1
2026.10.03.1
- Added: campaign
Added 1 behaviors
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
2026.09.23.1
2026.09.22.1
- Added: filter
Added 1 behaviors
2026.09.21.1
05Stats
A
100 / 100
Downloads
35
Archive size
1.6 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