Permanently delete an existing registration from your account.
post/#X-Amz-Target=PinpointSMSVoiceV2.DeleteRegistration
Headers
X-Amz-Target'PinpointSMSVoiceV2.DeleteRegistration' required
Request body
RegistrationIdstring required
The unique identifier for the registration.
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. 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.
ApprovedVersionNumberinteger
The version number of the registration that was approved.
LatestDeniedVersionNumberinteger
The latest version number of the registration that was denied.
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.