Aws/cases
@swamp/aws/casesv2026.09.15.1
01README
AWS CASES infrastructure models
02Models
@swamp/aws/cases/casev2026.08.20.1case.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. |
| DomainId | string | The unique identifier of the Cases domain. |
| TemplateId | string | A unique identifier of a template. |
| Title | string | The title of the case. |
| CustomerId | string | The full customer profile ARN for the case. |
| Tags? | array | A list of tags for the case. |
fn create()
Create a Cases Case
fn get(identifier: string)
Get a Cases Case
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Cases Case |
fn update()
Update a Cases Case
fn delete(identifier: string)
Delete a Cases Case
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Cases Case |
fn sync()
Sync Cases Case state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Cases Case 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)— Cases Case resource state
@swamp/aws/cases/case-rulev2026.08.17.2case_rule.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 | A description explaining the purpose and behavior of this case rule. Helps administrators understand when and why this rule applies to case fields. |
| DomainId? | string | The unique identifier of the Cases domain. |
| Name | string | A descriptive name for the case rule. Must be unique within the domain and should clearly indicate the rule's purpose (e.g., 'Priority Field Required for Urgent Cases'). |
| Rule | object | Defines the rule behavior and conditions. Specifies the rule type and the conditions under which it applies. In the Amazon Connect admin website, this corresponds to case field conditions. |
| Tags? | array | The tags that you attach to this case rule. |
fn create()
Create a Cases CaseRule
fn get(identifier: string)
Get a Cases CaseRule
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Cases CaseRule |
fn update()
Update a Cases CaseRule
fn delete(identifier: string)
Delete a Cases CaseRule
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Cases CaseRule |
fn sync()
Sync Cases CaseRule state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Cases CaseRule 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)— Cases CaseRule resource state
@swamp/aws/cases/domainv2026.08.17.2domain.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 your Cases domain. It must be unique for your AWS account. |
| Tags? | array | The tags that you attach to this domain. |
fn create()
Create a Cases Domain
fn get(identifier: string)
Get a Cases Domain
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Cases Domain |
fn update()
Update a Cases Domain
fn delete(identifier: string)
Delete a Cases Domain
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Cases Domain |
fn sync()
Sync Cases Domain state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Cases 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)— Cases Domain resource state
@swamp/aws/cases/fieldv2026.08.17.2field.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 | A description explaining the purpose and usage of this field in cases. Helps agents and administrators understand what information should be captured in this field. |
| DomainId? | string | The unique identifier of the Cases domain. |
| Name | string | The display name of the field as it appears to agents in the case interface. Should be descriptive and user-friendly (e.g., 'Customer Priority Level', 'Issue Category'). |
| Tags? | array | The tags that you attach to this field. |
| Type | enum | The data type of the field, which determines validation rules, input constraints, and display format. Each type has specific constraints: Text (string input), Number (numeric values), Boolean (true/false), DateTime (date/time picker), SingleSelect (dropdown options), Url (URL validation), User (Amazon Connect user selection). |
| Attributes? | object | Field-type specific attributes that control rendering and validation behavior |
fn create()
Create a Cases Field
fn get(identifier: string)
Get a Cases Field
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Cases Field |
fn update()
Update a Cases Field
fn delete(identifier: string)
Delete a Cases Field
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Cases Field |
fn sync()
Sync Cases Field state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Cases Field 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)— Cases Field resource state
@swamp/aws/cases/layoutv2026.08.17.2layout.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. |
| Content | object | Defines the layout structure and field organization for the case interface. Specifies which fields appear in the top panel and More Info tab, and their display order. |
| DomainId? | string | The unique identifier of the Cases domain. |
| Name | string | A descriptive name for the layout. Must be unique within the Cases domain and should clearly indicate the layout's purpose and field organization. |
| Tags? | array | The tags that you attach to this layout. |
fn create()
Create a Cases Layout
fn get(identifier: string)
Get a Cases Layout
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Cases Layout |
fn update()
Update a Cases Layout
fn delete(identifier: string)
Delete a Cases Layout
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Cases Layout |
fn sync()
Sync Cases Layout state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Cases Layout 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)— Cases Layout resource state
@swamp/aws/cases/templatev2026.08.17.2template.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. |
| DomainId? | string | The unique identifier of the Cases domain. |
| Name | string | A name for the template. It must be unique per domain. |
| Description? | string | A description explaining the purpose and use case for this template. Should indicate what types of cases this template is designed for and any specific workflow it supports. |
| LayoutConfiguration? | object | Specifies the default layout to use when displaying cases created from this template. The layout determines which fields are visible and their arrangement in the agent interface. |
| RequiredFields? | array | A list of fields that must contain a value for a case to be successfully created with this template. |
| Rules? | array | A list of case rules (also known as case field conditions) on a template. |
| Status? | enum | The current status of the template. Active templates can be used to create new cases, while Inactive templates are disabled but preserved for existing cases. |
| Tags? | array | The tags that you attach to this template. |
fn create()
Create a Cases Template
fn get(identifier: string)
Get a Cases Template
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Cases Template |
fn update()
Update a Cases Template
fn delete(identifier: string)
Delete a Cases Template
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the Cases Template |
fn sync()
Sync Cases Template state from AWS
fn list(maxPages?: number, resourceModel?: string)
List Cases Template 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)— Cases Template resource state
03Previous Versions
2026.09.14.1
2026.09.13.1
2026.09.12.1
2026.09.11.1
2026.09.10.1
2026.09.09.1
2026.09.08.1
2026.09.07.1
2026.09.06.3
2026.09.06.1
2026.09.05.1
2026.09.04.1
2026.09.03.1
2026.09.02.1
2026.09.01.1
2026.08.31.1
2026.08.30.1
2026.08.29.1
2026.08.28.1
04Stats
A
100 / 100
Downloads
0
Archive size
1.5 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
- License declared1/1earned
- Verified public repository2/2earned
05Platforms
06Labels