Skip to main content

Aws/smsvoice

@swamp/aws/smsvoicev2026.10.25.1· AGPL-3.0-or-later· 1d agoBEHAVIORS
01README

AWS SMSVOICE infrastructure models

02Behaviors10
@swamp/aws/smsvoice/configuration-setv2026.10.23.1configuration_set.ts

Global Arguments

ArgumentTypeDescription
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
ConfigurationSetName?stringThe name to use for the configuration set.
DefaultSenderId?stringThe default sender ID to set for the ConfigurationSet.
MessageFeedbackEnabled?booleanSet to true to enable message feedback.
ProtectConfigurationId?stringThe unique identifier for the protect configuration to be associated to the configuration set.
EventDestinations?arrayAn event destination is a location where you send message events.
Tags?arrayAn array of key-value pairs to apply to this resource.
fn create()
Create a SMSVOICE ConfigurationSet
fn get(identifier: string)
Get a SMSVOICE ConfigurationSet
ArgumentTypeDescription
identifierstringThe primary identifier of the SMSVOICE ConfigurationSet
fn update()
Update a SMSVOICE ConfigurationSet
fn delete(identifier: string)
Delete a SMSVOICE ConfigurationSet
ArgumentTypeDescription
identifierstringThe primary identifier of the SMSVOICE ConfigurationSet
fn sync()
Sync SMSVOICE ConfigurationSet state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SMSVOICE ConfigurationSet resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— SMSVOICE ConfigurationSet resource state
@swamp/aws/smsvoice/notify-configurationv2026.10.23.1notify_configuration.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
DisplayNamestringThe display name to associate with the notify configuration.
UseCaseenumThe use case for the notify configuration.
DefaultTemplateId?stringThe default template identifier to associate with the notify configuration. If specified, this template is used when sending messages without an explicit template identifier.
PoolId?stringThe identifier of the pool to associate with the notify configuration.
EnabledCountries?arrayAn array of two-character ISO country codes, in ISO 3166-1 alpha-2 format, that are enabled for the notify configuration.
EnabledChannelsarrayAn array of channels to enable for the notify configuration. Supported values include SMS and VOICE.
DeletionProtectionEnabled?booleanBy default this is set to false. When set to true the notify configuration can't be deleted.
Tags?arrayAn array of tags (key and value pairs) associated with the notify configuration.
fn create()
Create a SMSVOICE NotifyConfiguration
fn get(identifier: string)
Get a SMSVOICE NotifyConfiguration
ArgumentTypeDescription
identifierstringThe primary identifier of the SMSVOICE NotifyConfiguration
fn update()
Update a SMSVOICE NotifyConfiguration
fn delete(identifier: string)
Delete a SMSVOICE NotifyConfiguration
ArgumentTypeDescription
identifierstringThe primary identifier of the SMSVOICE NotifyConfiguration
fn sync()
Sync SMSVOICE NotifyConfiguration state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SMSVOICE NotifyConfiguration resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— SMSVOICE NotifyConfiguration resource state
@swamp/aws/smsvoice/opt-out-listv2026.10.23.1opt_out_list.ts

Global Arguments

ArgumentTypeDescription
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
OptOutListName?stringThe name of the new OptOutList.
Tags?arrayAn array of key-value pairs to apply to this resource.
fn create()
Create a SMSVOICE OptOutList
fn get(identifier: string)
Get a SMSVOICE OptOutList
ArgumentTypeDescription
identifierstringThe primary identifier of the SMSVOICE OptOutList
fn update()
Update a SMSVOICE OptOutList
fn delete(identifier: string)
Delete a SMSVOICE OptOutList
ArgumentTypeDescription
identifierstringThe primary identifier of the SMSVOICE OptOutList
fn sync()
Sync SMSVOICE OptOutList state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SMSVOICE OptOutList resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— SMSVOICE OptOutList resource state
@swamp/aws/smsvoice/protect-configurationv2026.10.23.1protect_configuration.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
CountryRuleSet?objectAn array of CountryRule containing the rules for the NumberCapability.
DeletionProtectionEnabled?booleanWhen set to true deletion protection is enabled and protect configuration cannot be deleted. By default this is set to false.
Tags?arrayAn array of key-value pairs to apply to this resource.
fn create()
Create a SMSVOICE ProtectConfiguration
fn get(identifier: string)
Get a SMSVOICE ProtectConfiguration
ArgumentTypeDescription
identifierstringThe primary identifier of the SMSVOICE ProtectConfiguration
fn update()
Update a SMSVOICE ProtectConfiguration
fn delete(identifier: string)
Delete a SMSVOICE ProtectConfiguration
ArgumentTypeDescription
identifierstringThe primary identifier of the SMSVOICE ProtectConfiguration
fn sync()
Sync SMSVOICE ProtectConfiguration state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SMSVOICE ProtectConfiguration resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— SMSVOICE ProtectConfiguration resource state
@swamp/aws/smsvoice/rcs-agentv2026.10.23.1rcs_agent.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
DeletionProtectionEnabled?booleanWhen set to true the RCS agent can't be deleted. By default this is false.
OptOutListName?stringThe name of the opt-out list associated with the RCS agent.
SelfManagedOptOutsEnabled?booleanWhen set to true you're responsible for responding to HELP and STOP requests, and for tracking and honoring opt-out requests. By default this is false.
TwoWayEnabled?booleanWhen set to true two-way messaging is enabled for the RCS agent.
TwoWayChannelArn?stringThe Amazon Resource Name (ARN) of the two way channel where inbound messages are delivered.
TwoWayChannelRole?stringThe Amazon Resource Name (ARN) of an IAM role for the service to assume in order to post inbound messages to the two way channel.
TwoWayMediaS3BucketName?stringThe name of the Amazon S3 bucket where inbound RCS media objects are written.
TwoWayMediaS3KeyPrefix?stringThe key prefix used for inbound RCS media objects in the Amazon S3 bucket.
TwoWayMediaS3Role?stringThe Amazon Resource Name (ARN) of the IAM role used to write inbound RCS media files to the Amazon S3 bucket. The role must have s3:PutObject permission on the bucket and a trust policy allowing sms-voice.amazonaws.com to assume it.
TwoWayRcsEventsEnabled?arrayThe list of RCS event types enabled for two-way messaging. An empty list disables all event types. The special value ALL enables all current and future event types and must be the only element if used. Requires TwoWayEnabled to be true.
TestingAgent?objectInformation about the testing agent (RCS for Business ID) associated with the RCS agent. A testing agent is created by submitting a testing registration, and allows sending to registered test devices without carrier approval.
Tags?arrayAn array of key-value pairs to apply to the RCS agent.
fn create()
Create a SMSVOICE RcsAgent
fn get(identifier: string)
Get a SMSVOICE RcsAgent
ArgumentTypeDescription
identifierstringThe primary identifier of the SMSVOICE RcsAgent
fn update()
Update a SMSVOICE RcsAgent
fn delete(identifier: string)
Delete a SMSVOICE RcsAgent
ArgumentTypeDescription
identifierstringThe primary identifier of the SMSVOICE RcsAgent
fn sync()
Sync SMSVOICE RcsAgent state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SMSVOICE RcsAgent resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— SMSVOICE RcsAgent resource state
@swamp/aws/smsvoice/registrationv2026.10.23.1registration.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
RegistrationTypestringThe type of registration form to create.
Tags?arrayAn array of tags (key and value pairs) to associate with the registration.
fn create()
Create a SMSVOICE Registration
fn get(identifier: string)
Get a SMSVOICE Registration
ArgumentTypeDescription
identifierstringThe primary identifier of the SMSVOICE Registration
fn update()
Update a SMSVOICE Registration
fn delete(identifier: string)
Delete a SMSVOICE Registration
ArgumentTypeDescription
identifierstringThe primary identifier of the SMSVOICE Registration
fn sync()
Sync SMSVOICE Registration state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SMSVOICE Registration resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— SMSVOICE Registration resource state
@swamp/aws/smsvoice/registration-attachmentv2026.10.23.1registration_attachment.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
AttachmentBody?stringThe registration file to upload. The maximum file size is 1500KB and valid file extensions are PDF, JPEG and PNG.
AttachmentUrl?stringA URL to the required registration file. For example, the URL to an MMS/shortcode form.
Tags?arrayAn array of tags (key and value pairs) to associate with the registration attachment.
fn create()
Create a SMSVOICE RegistrationAttachment
fn get(identifier: string)
Get a SMSVOICE RegistrationAttachment
ArgumentTypeDescription
identifierstringThe primary identifier of the SMSVOICE RegistrationAttachment
fn update()
Update a SMSVOICE RegistrationAttachment
fn delete(identifier: string)
Delete a SMSVOICE RegistrationAttachment
ArgumentTypeDescription
identifierstringThe primary identifier of the SMSVOICE RegistrationAttachment
fn sync()
Sync SMSVOICE RegistrationAttachment state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SMSVOICE RegistrationAttachment resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— SMSVOICE RegistrationAttachment resource state
@swamp/aws/smsvoice/resource-policyv2026.10.23.1resource_policy.ts

Global Arguments

ArgumentTypeDescription
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
ResourceArnstringThe Amazon Resource Name (ARN) of the AWS End User Messaging SMS and Voice resource to attach the resource-based policy to.
PolicyDocumentrecordThe JSON formatted resource-based policy to attach.
fn create()
Create a SMSVOICE ResourcePolicy
fn get(identifier: string)
Get a SMSVOICE ResourcePolicy
ArgumentTypeDescription
identifierstringThe primary identifier of the SMSVOICE ResourcePolicy
fn update()
Update a SMSVOICE ResourcePolicy
fn delete(identifier: string)
Delete a SMSVOICE ResourcePolicy
ArgumentTypeDescription
identifierstringThe primary identifier of the SMSVOICE ResourcePolicy
fn sync()
Sync SMSVOICE ResourcePolicy state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SMSVOICE ResourcePolicy resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— SMSVOICE ResourcePolicy resource state
@swamp/aws/smsvoice/sender-idv2026.10.23.1sender_id.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
IsoCountryCodestringThe two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
SenderIdstringThe sender ID string to request.
DeletionProtectionEnabled?booleanWhen set to true the sender ID can't be deleted. By default this is set to false.
Tags?arrayAn array of key-value pairs to apply to this resource.
fn create()
Create a SMSVOICE SenderId
fn get(identifier: string)
Get a SMSVOICE SenderId
ArgumentTypeDescription
identifierstringThe primary identifier of the SMSVOICE SenderId
fn update()
Update a SMSVOICE SenderId
fn delete(identifier: string)
Delete a SMSVOICE SenderId
ArgumentTypeDescription
identifierstringThe primary identifier of the SMSVOICE SenderId
fn sync()
Sync SMSVOICE SenderId state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SMSVOICE SenderId resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— SMSVOICE SenderId resource state
@swamp/aws/smsvoice/verified-destination-numberv2026.10.23.1verified_destination_number.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
DestinationPhoneNumberstringThe verified destination phone number, in E.164 format.
Tags?arrayAn array of key-value pairs to apply to this resource.
fn create()
Create a SMSVOICE VerifiedDestinationNumber
fn get(identifier: string)
Get a SMSVOICE VerifiedDestinationNumber
ArgumentTypeDescription
identifierstringThe primary identifier of the SMSVOICE VerifiedDestinationNumber
fn update()
Update a SMSVOICE VerifiedDestinationNumber
fn delete(identifier: string)
Delete a SMSVOICE VerifiedDestinationNumber
ArgumentTypeDescription
identifierstringThe primary identifier of the SMSVOICE VerifiedDestinationNumber
fn sync()
Sync SMSVOICE VerifiedDestinationNumber state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SMSVOICE VerifiedDestinationNumber resources
ArgumentTypeDescription
maxPages?numberMaximum number of pages to fetch (default: 10)
resourceModel?stringJSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— SMSVOICE VerifiedDestinationNumber resource state
03Previous Versions19
2026.10.24.1AGPL-3.0-or-later
2026.10.23.1AGPL-3.0-or-later(was none)
  • Updated: configuration_set, notify_configuration, opt_out_list, protect_configuration, rcs_agent, registration, registration_attachment, resource_policy, sender_id, verified_destination_number
2026.10.13.1
  • Updated: configuration_set, notify_configuration, opt_out_list, protect_configuration, rcs_agent, registration, registration_attachment, resource_policy, sender_id, verified_destination_number
2026.10.08.1
2026.10.06.1
  • Added: notify_configuration, rcs_agent

Added 2 behaviors

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
  • Added: registration_attachment

Added 1 behaviors

2026.09.25.1
2026.09.24.1
2026.09.23.1

Added 1 behaviors

2026.09.21.1
2026.09.20.1
2026.09.19.1
04Stats
A
100 / 100
Downloads
35
Archive size
2.0 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
05Platforms
06Labels