• Public
  • Public/Protected
  • All

Interface RequestPhoneNumberCommandInput




Optional ClientToken

ClientToken: undefined | string

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.

Optional DeletionProtectionEnabled

DeletionProtectionEnabled: undefined | false | true

By default this is set to false. When set to true the phone number can't be deleted.


IsoCountryCode: string | undefined

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.


MessageType: MessageType | string | undefined

The 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.


NumberCapabilities: (NumberCapability | string)[] | undefined

Indicates if the phone number will be used for text messages, voice messages, or both.


NumberType: RequestableNumberType | string | undefined

The type of phone number to request.

Optional OptOutListName

OptOutListName: undefined | string

The name of the OptOutList to associate with the phone number. You can use the OutOutListName or OptPutListArn.

Optional PoolId

PoolId: undefined | string

The pool to associated with the phone number. You can use the PoolId or PoolArn.

Optional RegistrationId

RegistrationId: undefined | string

Use this field to attach your phone number for an external registration process.

Optional Tags

Tags: Tag[]

An array of tags (key and value pairs) associate with the requested phone number.