Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateRegistration

Creates a new registration based on the RegistrationType field.

Request Syntax


{
   "ClientToken": "string",
   "RegistrationType": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "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.

ClientToken

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [!-~]+

Required: No

RegistrationType

The type of registration form to create. 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_]+

Required: Yes

Tags

An array of tags (key and value pairs) to associate with the registration.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 200 items.

Required: No

Response Syntax


{
   "AdditionalAttributes": { 
      "string" : "string" 
   },
   "CreatedTimestamp": number,
   "CurrentVersionNumber": number,
   "RegistrationArn": "string",
   "RegistrationId": "string",
   "RegistrationStatus": "string",
   "RegistrationType": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "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

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.

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.

CLOSED: The phone number or sender ID has been deleted and you must also delete the registration for the number.
CREATED: Your registration is created but not submitted.
COMPLETE: Your registration has been approved and your origination identity has been created.
DELETED: The registration has been deleted.
PROVISIONING: Your registration has been approved and your origination identity is being created.
REQUIRES_AUTHENTICATION: You need to complete email authentication.
REQUIRES_UPDATES: You must fix your registration and resubmit it.
REVIEWING: Your registration has been accepted and is being reviewed.
SUBMITTED: Your registration has been submitted and is awaiting review.

Type: String

RegistrationType

The type of registration form to create. 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_]+

Tags

An array of tags (key and value pairs) to associate with the registration.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 200 items.

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

ServiceQuotaExceededException

The request would cause a service quota to be exceeded.

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