Pinpoint SMS and Voice Pool

An Amazon Pinpoint SMS and Voice Pool is a collection of phone numbers and sender IDs that can be managed together for sending messages. It allows you to group resources for better control over message routing, compliance, and throughput. Pools help ensure consistent sender identities, manage opt-outs, and improve deliverability by distributing traffic across multiple numbers.

aws.smsvoice_pool

Fields

TitleIDTypeData TypeDescription
_keycorestring
account_idcorestring
created_timestampcoretimestampThe time when the pool was created, in UNIX epoch time format.
deletion_protection_enabledcoreboolWhen set to true the pool can't be deleted.
message_typecorestringThe type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
opt_out_list_namecorestringThe name of the OptOutList associated with the pool.
pool_arncorestringThe Amazon Resource Name (ARN) for the pool.
pool_idcorestringThe unique identifier for the pool.
self_managed_opt_outs_enabledcoreboolWhen set to false, an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests. For more information see Self-managed opt-outs
shared_routes_enabledcoreboolAllows you to enable shared routes on your pool. By default, this is set to False. If you set this value to True, your messages are sent using phone numbers or sender IDs (depending on the country) that are shared with other users. In some countries, such as the United States, senders aren't allowed to use shared routes and must use a dedicated phone number or short code.
statuscorestringThe current status of the pool.
tagscorehstore
two_way_channel_arncorestringThe Amazon Resource Name (ARN) of the two way channel.
two_way_channel_rolecorestringAn optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
two_way_enabledcoreboolWhen set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.