[Enhancement]: aws_pinpointsmsvoicev2_phone_number

[fogers777]

Description

Currently aws_pinpointsmsvoicev2_phone_number resource doesn't support SHORT_CODE, so we can't use it with short code numbers.

resource "aws_pinpointsmsvoicev2_phone_number" "short_code_number":
│ 38: number_type = "SHORT_CODE"
│
│ The provided value does not match any valid values.
│
│ Path: number_type
│ Given Value: SHORT_CODE
│ Valid Values: [LONG_CODE TOLL_FREE TEN_DLC SIMULATOR ]

as per https://github.com/aws/aws-sdk-go/blob/8d203ccff393340d080be0417d091cc60354449b/models/apis/pinpoint-sms-voice-v2/2022-03-31/api-2.json#L3153 it's available and supportes.

Also TwoWayChannelRole is also missing in aws_pinpointsmsvoicev2_phone_number, so would be great to add support for it too.

Thanks!

Affected Resource(s) and/or Data Source(s)

aws_pinpointsmsvoicev2_phone_number

Potential Terraform Configuration

References

No response

Would you like to implement a fix?

None

[github-actions]

Community Guidelines

This comment is added to every new Issue to provide quick reference to how the Terraform AWS Provider is maintained. Please review the information below, and thank you for contributing to the community that keeps the provider thriving! 🚀

Voting for Prioritization

• Please vote on this Issue by adding a 👍 reaction to the original post to help the community and maintainers prioritize it.
• Please see our prioritization guide for additional information on how the maintainers handle prioritization.
• Please do not leave +1 or other comments that do not add relevant new information or questions; they generate extra noise for others following the Issue and do not help prioritize the request.

Volunteering to Work on This Issue

• If you are interested in working on this issue, please leave a comment.
• If this would be your first contribution, please review the contribution guide.
• For new resources and data sources, use skaff to generate scaffolding with comments detailing common expectations.

[stefanfreitag]

Hi @fogers777, hi @justinretzolk ,

I was trying to understand the required changes for resolving the issue and thought I better ask for clarifcation.

In the Terraform provider source code I see for the number_type a custom type

CustomType: fwtypes.StringEnumType[awstypes.RequestableNumberType](),

The RequestableNumberType is defined in the AWS SDK as below and does not contain the SHORT_CODE value:

type RequestableNumberType string

// Enum values for RequestableNumberType
const (
	RequestableNumberTypeLongCode  RequestableNumberType = "LONG_CODE"
	RequestableNumberTypeTollFree  RequestableNumberType = "TOLL_FREE"
	RequestableNumberTypeTenDlc    RequestableNumberType = "TEN_DLC"
	RequestableNumberTypeSimulator RequestableNumberType = "SIMULATOR"
)

I think this explains the issue reported.

The provided link to the json model points to NumberType and not RequestableNumberType. Are we looking here into the right place in the JSON model?

I am asking because in the same JSON document there is the RequestPhoneNumberRequest as

"RequestPhoneNumberRequest":{
      "type":"structure",
      "required":[
        "IsoCountryCode",
        "MessageType",
        "NumberCapabilities",
        "NumberType"
      ],
      "members":{
        "IsoCountryCode":{"shape":"IsoCountryCode"},
        "MessageType":{"shape":"MessageType"},
        "NumberCapabilities":{"shape":"NumberCapabilityList"},
        "NumberType":{"shape":"RequestableNumberType"}, <--
        "OptOutListName":{"shape":"OptOutListNameOrArn"},
        "PoolId":{"shape":"PoolIdOrArn"},
        "RegistrationId":{"shape":"RegistrationIdOrArn"},
        "DeletionProtectionEnabled":{"shape":"Boolean"},
        "Tags":{"shape":"TagList"},
        "ClientToken":{
          "shape":"ClientToken",
          "idempotencyToken":true
        }
      }
    },

and the RequestPhoneNumber request (utilizing RequestableNumberType) is used in the Create function of the resource:

var data phoneNumberResourceModel
response.Diagnostics.Append(request.Plan.Get(ctx, &data)...)
if response.Diagnostics.HasError() {
	return
}

conn := r.Meta().PinpointSMSVoiceV2Client(ctx)

input := &pinpointsmsvoicev2.RequestPhoneNumberInput{}
response.Diagnostics.Append(fwflex.Expand(ctx, data, input)...)
if response.Diagnostics.HasError() {
	return
}

// Additional fields.
input.ClientToken = aws.String(sdkid.UniqueId())
input.Tags = getTagsIn(ctx)

output, err := conn.RequestPhoneNumber(ctx, input)

So, it feels to me that an upstream change would be required here first. Or do you see it different?

[fogers777]

Hi @stefanfreitag thanks for your input! I believe you are right. I just checked if it has short_code and didn't check that it wasn't RequestableNumberType. So it seems it would require an upstream change to support short_code.

[act-mreeves]

I want to give a +1 and emphasize that TwoWayChannelRole is missing.

As of aws cli version 2.25.6 at least this is what is returned when I run:

{
            "PhoneNumberArn": "arn:aws:sms-voice:us-east-1:REDACTED:phone-number/phone-REDACTED",
            "PhoneNumberId": "phone-REDACTED",
            "PhoneNumber": "+REDACTED",
            "Status": "ACTIVE",
            "IsoCountryCode": "US",
            "MessageType": "TRANSACTIONAL",
            "NumberCapabilities": [
                "SMS"
            ],
            "NumberType": "TEN_DLC",
            "MonthlyLeasingPrice": "1.00",
            "TwoWayEnabled": true,
            "TwoWayChannelArn": "arn:aws:sns:us-east-1:REDACTED:foo-bar",
            "TwoWayChannelRole": "arn:aws:iam::REDACTED:role/foobar",
            "SelfManagedOptOutsEnabled": false,
            "OptOutListName": "Default",
            "DeletionProtectionEnabled": false,
            "RegistrationId": "registration-REDACTED",
            "CreatedTimestamp": "2025-04-24T13:11:10-07:00"
        }

Thanks!

[naari3]

It seems that we can't actually request a short code with RequestPhoneNumber, but we can create a PhoneNumber with a descriptive SHORT_CODE attribute by creating a AWS support ticket.
There are many use cases where we can import the created resource and track various attributes, so I created the following PR.
#44537