SupportedAssociation - Amazon Pinpoint SMS and Voice v2 API

SupportedAssociation

The processing rules for when a registration can be associated with an origination identity and disassociated from an origination identity.

Contents

AssociationBehavior

The association behavior.

  • ASSOCIATE_BEFORE_SUBMIT The origination identity has to be supplied when creating a registration.

  • ASSOCIATE_ON_APPROVAL This applies to all short code registrations. The short code will be automatically provisioned once the registration is approved.

  • ASSOCIATE_AFTER_COMPLETE This applies to phone number registrations when you must complete a registration first, then associate one or more phone numbers later. For example 10DLC campaigns and long codes.

Type: String

Valid Values: ASSOCIATE_BEFORE_SUBMIT | ASSOCIATE_ON_APPROVAL | ASSOCIATE_AFTER_COMPLETE

Required: Yes

DisassociationBehavior

The disassociation behavior.

  • DISASSOCIATE_ALL_CLOSES_REGISTRATION All origination identities must be disassociated from the registration before the registration can be closed.

  • DISASSOCIATE_ALL_ALLOWS_DELETE_REGISTRATION All origination identities must be disassociated from the registration before the registration can be deleted.

  • DELETE_REGISTRATION_DISASSOCIATES The registration can be deleted and all origination identities will be disasscoiated.

Type: String

Valid Values: DISASSOCIATE_ALL_CLOSES_REGISTRATION | DISASSOCIATE_ALL_ALLOWS_DELETE_REGISTRATION | DELETE_REGISTRATION_DISASSOCIATES

Required: Yes

ResourceType

Defines the behavior of when an origination identity and registration can be associated with each other.

Type: String

Required: Yes

IsoCountryCode

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

Type: String

Length Constraints: Fixed length of 2.

Pattern: [A-Z]{2}

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: