DeleteRegistration
Permanently delete an existing registration from your account.
Request Syntax
{
"RegistrationId": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- RegistrationId
-
The unique identifier for the registration.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[A-Za-z0-9_:/-]+Required: Yes
Response Syntax
{
"AdditionalAttributes": {
"string" : "string"
},
"ApprovedVersionNumber": number,
"CreatedTimestamp": number,
"CurrentVersionNumber": number,
"LatestDeniedVersionNumber": number,
"RegistrationArn": "string",
"RegistrationId": "string",
"RegistrationStatus": "string",
"RegistrationType": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- AdditionalAttributes
-
Metadata about a given registration which is specific to that registration type.
Type: String to string map
- ApprovedVersionNumber
-
The version number of the registration that was approved.
Type: Long
Valid Range: Minimum value of 1. Maximum value of 100000.
- CreatedTimestamp
-
The time when the registration was created, in UNIX epoch time
format. Type: Timestamp
- CurrentVersionNumber
-
The current version number of the registration.
Type: Long
Valid Range: Minimum value of 1. Maximum value of 100000.
- LatestDeniedVersionNumber
-
The latest version number of the registration that was denied.
Type: Long
Valid Range: Minimum value of 1. Maximum value of 100000.
- RegistrationArn
-
The Amazon Resource Name (ARN) for the registration.
Type: String
- RegistrationId
-
The unique identifier for the registration.
Type: String
- RegistrationStatus
-
The status of the registration.
-
CREATED: Your registration is created but not submitted. -
SUBMITTED: Your registration has been submitted and is awaiting review. -
REVIEWING: Your registration has been accepted and is being reviewed. -
PROVISIONING: Your registration has been approved and your origination identity is being created. -
COMPLETE: Your registration has been approved and and your origination identity has been created. -
REQUIRES_UPDATES: You must fix your registration and resubmit it. -
CLOSED: The phone number or sender ID has been deleted and you must also delete the registration for the number. -
DELETED: The registration has been deleted.
Type: String
Valid Values:
CREATED | SUBMITTED | REVIEWING | PROVISIONING | COMPLETE | REQUIRES_UPDATES | CLOSED | DELETED -
- RegistrationType
-
The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[A-Za-z0-9_]+
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The request was denied because you don't have sufficient permissions to access the resource.
HTTP Status Code: 400
- ConflictException
-
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
HTTP Status Code: 400
- InternalServerException
-
The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
HTTP Status Code: 500
- ResourceNotFoundException
-
A requested resource couldn't be found.
HTTP Status Code: 400
- ThrottlingException
-
An error that occurred because too many requests were sent during a certain amount of time.
HTTP Status Code: 400
- ValidationException
-
A validation exception for a field.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
