Aws/wellarchitected
@swamp/aws/wellarchitectedv2026.10.13.1
01README
AWS WELLARCHITECTED infrastructure models
02Release Notes
- Updated: agent_context, agent_goal, agent_profile, lens, profile, review_template, workload
03Behaviors
@swamp/aws/wellarchitected/agent-contextv2026.10.13.1agent_context.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. |
| ProfileArn | string | The Amazon Resource Name (ARN) of the parent Agent Profile that owns this context. Pass `!Ref` of the parent AWS::WellArchitected::AgentProfile to flow its ARN here. |
| Title | string | The title of the Agent Context. |
| ContextType | enum | The type of the Agent Context. |
| Content | record | The free-form content of the Agent Context, supplied as an arbitrary JSON object. |
fn create()
Create a WellArchitected AgentContext
fn get(identifier: string)
Get a WellArchitected AgentContext
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the WellArchitected AgentContext |
fn update()
Update a WellArchitected AgentContext
fn delete(identifier: string)
Delete a WellArchitected AgentContext
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the WellArchitected AgentContext |
fn sync()
Sync WellArchitected AgentContext state from AWS
fn list(maxPages?: number, resourceModel?: string)
List WellArchitected AgentContext 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)— WellArchitected AgentContext resource state
@swamp/aws/wellarchitected/agent-goalv2026.10.13.1agent_goal.ts
fn create()
Create a WellArchitected AgentGoal
fn get(identifier: string)
Get a WellArchitected AgentGoal
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the WellArchitected AgentGoal |
fn update()
Update a WellArchitected AgentGoal
fn delete(identifier: string)
Delete a WellArchitected AgentGoal
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the WellArchitected AgentGoal |
fn sync()
Sync WellArchitected AgentGoal state from AWS
fn list(maxPages?: number, resourceModel?: string)
List WellArchitected AgentGoal 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)— WellArchitected AgentGoal resource state
@swamp/aws/wellarchitected/agent-profilev2026.10.13.1agent_profile.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 profile. Unique within the account and used as the last component of the ARN. |
| DisplayName? | string | The human-readable display name of the profile. |
| Description? | string | A description of the profile. |
| BusinessOverview? | string | A business overview for the profile used to improve recommendation quality. |
| ExecutionRoleArn | string | The ARN of the IAM role assumed to execute recommendation actions. |
| Pillars | array | The list of Well-Architected pillars to focus on. |
| AggregationConfiguration | array | The aggregation configuration entries (account, regions, access role) associated with this profile. |
| DeletionProtection? | boolean | Whether deletion protection is enabled for the profile. When enabled, the profile cannot be deleted until deletion protection is disabled. |
| Tags? | array | Key-value pairs to associate with the Agent Profile. |
fn create()
Create a WellArchitected AgentProfile
fn get(identifier: string)
Get a WellArchitected AgentProfile
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the WellArchitected AgentProfile |
fn update()
Update a WellArchitected AgentProfile
fn delete(identifier: string)
Delete a WellArchitected AgentProfile
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the WellArchitected AgentProfile |
fn sync()
Sync WellArchitected AgentProfile state from AWS
fn list(maxPages?: number, resourceModel?: string)
List WellArchitected AgentProfile 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)— WellArchitected AgentProfile resource state
@swamp/aws/wellarchitected/lensv2026.10.13.1lens.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. |
| JSONString? | string | The JSON representation of a lens. |
| LensVersion? | string | The version of the lens. |
| Tags? | array | The tags assigned to the lens. |
fn create()
Create a WellArchitected Lens
fn get(identifier: string)
Get a WellArchitected Lens
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the WellArchitected Lens |
fn update()
Update a WellArchitected Lens
fn delete(identifier: string)
Delete a WellArchitected Lens
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the WellArchitected Lens |
fn sync()
Sync WellArchitected Lens state from AWS
fn list(maxPages?: number, resourceModel?: string)
List WellArchitected Lens 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)— WellArchitected Lens resource state
@swamp/aws/wellarchitected/profilev2026.10.13.1profile.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. |
| ProfileName | string | The name of the profile. |
| ProfileDescription | string | The profile description. |
| ProfileQuestions | array | The profile questions. |
| Tags? | array | The tags assigned to the profile. |
fn create()
Create a WellArchitected Profile
fn get(identifier: string)
Get a WellArchitected Profile
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the WellArchitected Profile |
fn update()
Update a WellArchitected Profile
fn delete(identifier: string)
Delete a WellArchitected Profile
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the WellArchitected Profile |
fn sync()
Sync WellArchitected Profile state from AWS
fn list(maxPages?: number, resourceModel?: string)
List WellArchitected Profile 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)— WellArchitected Profile resource state
@swamp/aws/wellarchitected/review-templatev2026.10.13.1review_template.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. |
| TemplateName | string | The name of the review template. |
| Description | string | The review template description. |
| Lenses | array | The lenses applied to the review template. |
| Notes? | string | The notes associated with the review template. |
| Tags? | array | The tags assigned to the review template. |
fn create()
Create a WellArchitected ReviewTemplate
fn get(identifier: string)
Get a WellArchitected ReviewTemplate
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the WellArchitected ReviewTemplate |
fn update()
Update a WellArchitected ReviewTemplate
fn delete(identifier: string)
Delete a WellArchitected ReviewTemplate
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the WellArchitected ReviewTemplate |
fn sync()
Sync WellArchitected ReviewTemplate state from AWS
fn list(maxPages?: number, resourceModel?: string)
List WellArchitected ReviewTemplate 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)— WellArchitected ReviewTemplate resource state
@swamp/aws/wellarchitected/workloadv2026.10.13.1workload.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. |
| WorkloadName | string | The name of the workload. |
| Description | string | The description for the workload. |
| Environment | enum | The environment for the workload. |
| AccountIds? | array | The list of Amazon Web Services account IDs associated with the workload. |
| AwsRegions? | array | The list of Amazon Web Services Regions associated with the workload. |
| NonAwsRegions? | array | The list of non-Amazon Web Services Regions associated with the workload. |
| ArchitecturalDesign? | string | The URL of the architectural design for the workload. |
| ReviewOwner? | string | The review owner of the workload. |
| IndustryType? | string | The industry type for the workload. |
| Industry? | string | The industry for the workload. |
| Lenses | array | The list of lenses associated with the workload. |
| Notes? | string | The notes associated with the workload. |
| DiscoveryConfig? | object | Discovery configuration associated to the workload. |
| Tags? | array | The tags associated with the workload. |
fn create()
Create a WellArchitected Workload
fn get(identifier: string)
Get a WellArchitected Workload
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the WellArchitected Workload |
fn update()
Update a WellArchitected Workload
fn delete(identifier: string)
Delete a WellArchitected Workload
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the WellArchitected Workload |
fn sync()
Sync WellArchitected Workload state from AWS
fn list(maxPages?: number, resourceModel?: string)
List WellArchitected Workload 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)— WellArchitected Workload resource state
04Previous Versions
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
2026.09.23.1
2026.09.22.1
- Added: agent_context, agent_goal, agent_profile
Added 3 behaviors
2026.09.21.1
2026.09.20.1
2026.09.19.1
2026.09.18.1
05Stats
A
93 / 100
Downloads
22
Archive size
1.4 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
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License1/2partial
no SPDX license declared
- Verified public repository2/2earned
06Platforms
07Labels