What is a valid AWSPhone? What test values can be used?

user_159369 0
Viewed 1304

The docs say:

The AWSPhone scalar type represents a valid Phone Number. Phone numbers are serialized and deserialized as Strings. Phone numbers provided may be whitespace delimited or hyphenated. The number can specify a country code at the beginning but this is not required.

What determines whether a given string is a valid AWSPhone? In addition, is there any safe way to generate (possibly a large number of) AWSPhone test values that are guaranteed to be valid but assuredly are not in-use phone numbers?

aws-appsync graphql amazon-web-services
3 Answers
user_62418560

TLDR: You cannot tell the exact rules how the type AWSPhone is validated in AppSync. However, if a value passes the test of the regular expression /^\+?\d[\d\s-]+$/ or validation by libphonenumber-js, then it is likely to be accepted by AppSync.

In the latest AppSync Developer Guide (Oct 6, 2021 UTC), the description was updated to:

A phone number. This value is stored as a string. Phone numbers can contain either spaces or hyphens to separate digit groups. Phone numbers without a country code are assumed to be US/North American numbers adhering to the North American Numbering Plan (NANP).

This doesn't really tell exactly what AppSync expects. E.g. Must country code include + as prefix?

From AWS's public repositories on GitHub, there are hints:

  • amplify-js datastore util method for frontend validation:

    export const isAWSPhone = (val: string): boolean => {
   return !!/^\+?\d[\d\s-]+$/.exec(val);
};

  • amplify-appsync-simulator for amplify CLI mock features:

    //...
import { isValidNumber } from 'libphonenumber-js';
//...
const phoneValidator = (ast, options) => {
   //...
   let isValid = isValidNumber(value, country);
   //...
}

Therefore, a value is likely to be accepted by AppSync if it passes the above regex test and validation by libphonenumber-js (or libphonenumber, assuming they work equivalently).

user_10892420

libphonenumber-js finds both 5555551212 and 555-555-1212 as invalid. What I have read is area code 555 is not a valid area code. So it would be the ideal number to generate known invalid test phone numbers, as well as a perfect phone number area code to be a known invalid initializer. But alas, dynamodb declares it as invalid.

user_102513380
Related