Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14109583546.7 KB

Creates a new registration based on the <b>RegistrationType</b> field.

post/#X-Amz-Target=PinpointSMSVoiceV2.CreateRegistration

Headers

X-Amz-Target'PinpointSMSVoiceV2.CreateRegistration' required

Request body

RegistrationTypestring required

The type of registration form to create. The list of <b>RegistrationTypes</b> can be found using the <a>DescribeRegistrationTypeDefinitions</a> action.

ClientTokenstring

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.

Response

Success

RegistrationArnstring required

The Amazon Resource Name (ARN) for the registration.

RegistrationIdstring required

The unique identifier for the registration.

RegistrationTypestring required

The type of registration form to create. The list of <b>RegistrationTypes</b> can be found using the <a>DescribeRegistrationTypeDefinitions</a> action.

RegistrationStatus'CREATED' | 'SUBMITTED' | 'AWS_REVIEWING' | 'REVIEWING' | 'REQUIRES_AUTHENTICATION' | 'PROVISIONING' | 'COMPLETE' | 'REQUIRES_UPDATES' | 'CLOSED' | 'DELETED' required
<p>The status of the registration.</p> <ul> <li> <p> <code>CLOSED</code>: The phone number or sender ID has been deleted and you must also delete the registration for the number.</p> </li> <li> <p> <code>CREATED</code>: Your registration is created but not submitted.</p> </li> <li> <p> <code>COMPLETE</code>: Your registration has been approved and your origination identity has been created.</p> </li> <li> <p> <code>DELETED</code>: The registration has been deleted.</p> </li> <li> <p> <code>PROVISIONING</code>: Your registration has been approved and your origination identity is being created.</p> </li> <li> <p> <code>REQUIRES_AUTHENTICATION</code>: You need to complete email authentication.</p> </li> <li> <p> <code>REQUIRES_UPDATES</code>: You must fix your registration and resubmit it.</p> </li> <li> <p> <code>REVIEWING</code>: Your registration has been accepted and is being reviewed.</p> </li> <li> <p> <code>SUBMITTED</code>: Your registration has been submitted and is awaiting review.</p> </li> </ul>
CurrentVersionNumberinteger required

The current version number of the registration.

AdditionalAttributesobject

Metadata about a given registration which is specific to that registration type.

CreatedTimestampstring date-time required

The time when the registration was created, in <a href="https://www.epochconverter.com/">UNIX epoch time</a> format.