Skip to main content

@swamp/aws/cases

v2026.04.23.3

AWS CASES infrastructure models

Repository

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

Labels

awscasescloudinfrastructure

Contents

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/cases

@swamp/aws/cases/case-rulev2026.04.23.2case_rule.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
Description?stringA description explaining the purpose and behavior of this case rule. Helps administrators understand when and why this rule applies to case fields.
DomainId?stringThe unique identifier of the Cases domain.
NamestringA 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').
RuleobjectDefines 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?arrayThe tags that you attach to this case rule.
createCreate a Cases CaseRule
getGet a Cases CaseRule
ArgumentTypeDescription
identifierstringThe primary identifier of the Cases CaseRule
updateUpdate a Cases CaseRule
deleteDelete a Cases CaseRule
ArgumentTypeDescription
identifierstringThe primary identifier of the Cases CaseRule
syncSync Cases CaseRule state from AWS

Resources

state(infinite)— Cases CaseRule resource state
@swamp/aws/cases/domainv2026.04.23.2domain.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
NamestringThe name for your Cases domain. It must be unique for your AWS account.
Tags?arrayThe tags that you attach to this domain.
createCreate a Cases Domain
getGet a Cases Domain
ArgumentTypeDescription
identifierstringThe primary identifier of the Cases Domain
updateUpdate a Cases Domain
deleteDelete a Cases Domain
ArgumentTypeDescription
identifierstringThe primary identifier of the Cases Domain
syncSync Cases Domain state from AWS

Resources

state(infinite)— Cases Domain resource state
@swamp/aws/cases/fieldv2026.04.23.2field.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
Description?stringA 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?stringThe unique identifier of the Cases domain.
NamestringThe 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?arrayThe tags that you attach to this field.
TypeenumThe 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?objectField-type specific attributes that control rendering and validation behavior
createCreate a Cases Field
getGet a Cases Field
ArgumentTypeDescription
identifierstringThe primary identifier of the Cases Field
updateUpdate a Cases Field
deleteDelete a Cases Field
ArgumentTypeDescription
identifierstringThe primary identifier of the Cases Field
syncSync Cases Field state from AWS

Resources

state(infinite)— Cases Field resource state
@swamp/aws/cases/layoutv2026.04.23.2layout.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
ContentobjectDefines 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?stringThe unique identifier of the Cases domain.
NamestringA descriptive name for the layout. Must be unique within the Cases domain and should clearly indicate the layout's purpose and field organization.
Tags?arrayThe tags that you attach to this layout.
createCreate a Cases Layout
getGet a Cases Layout
ArgumentTypeDescription
identifierstringThe primary identifier of the Cases Layout
updateUpdate a Cases Layout
deleteDelete a Cases Layout
ArgumentTypeDescription
identifierstringThe primary identifier of the Cases Layout
syncSync Cases Layout state from AWS

Resources

state(infinite)— Cases Layout resource state
@swamp/aws/cases/templatev2026.04.23.2template.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
DomainId?stringThe unique identifier of the Cases domain.
NamestringA name for the template. It must be unique per domain.
Description?stringA 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?objectSpecifies 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?arrayA list of fields that must contain a value for a case to be successfully created with this template.
Rules?arrayA list of case rules (also known as case field conditions) on a template.
Status?enumThe 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?arrayThe tags that you attach to this template.
createCreate a Cases Template
getGet a Cases Template
ArgumentTypeDescription
identifierstringThe primary identifier of the Cases Template
updateUpdate a Cases Template
deleteDelete a Cases Template
ArgumentTypeDescription
identifierstringThe primary identifier of the Cases Template
syncSync Cases Template state from AWS

Resources

state(infinite)— Cases Template resource state