CreateRegistrationVersion - AWS End User Messaging SMS

CreateRegistrationVersion

Create a new version of the registration and increase the VersionNumber. The previous version of the registration becomes read-only.

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

{ "RegistrationArn": "string", "RegistrationId": "string", "RegistrationVersionStatus": "string", "RegistrationVersionStatusHistory": { "ApprovedTimestamp": number, "ArchivedTimestamp": number, "DeniedTimestamp": number, "DiscardedTimestamp": number, "DraftTimestamp": number, "ReviewingTimestamp": number, "RevokedTimestamp": number, "SubmittedTimestamp": number }, "VersionNumber": number }

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.

RegistrationArn

The Amazon Resource Name (ARN) for the registration.

Type: String

RegistrationId

The unique identifier for the registration.

Type: String

RegistrationVersionStatus

The status of the registration.

  • APPROVED: Your registration has been approved.

  • ARCHIVED: Your previously approved registration version moves into this status when a more recently submitted version is approved.

  • DENIED: You must fix your registration and resubmit it.

  • DISCARDED: You've abandon this version of their registration to start over with a new version.

  • DRAFT: The initial status of a registration version after it’s created.

  • REQUIRES_AUTHENTICATION: You need to complete email authentication.

  • REVIEWING: Your registration has been accepted and is being reviewed.

  • REVOKED: Your previously approved registration has been revoked.

  • SUBMITTED: Your registration has been submitted.

Type: String

Valid Values: DRAFT | SUBMITTED | REVIEWING | REQUIRES_AUTHENTICATION | APPROVED | DISCARDED | DENIED | REVOKED | ARCHIVED

RegistrationVersionStatusHistory

A RegistrationVersionStatusHistory object that contains timestamps for the registration.

Type: RegistrationVersionStatusHistory object

VersionNumber

The new version number of the registration.

Type: Long

Valid Range: Minimum value of 1. Maximum value of 100000.

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

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

See Also

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