Provides information about the requested registration.
Contents
- CreatedTimestamp
-
The time when the registration was created, in UNIX epoch time
format. Type: Timestamp
Required: Yes
- CurrentVersionNumber
-
The current version number of the registration.
Type: Long
Valid Range: Minimum value of 1. Maximum value of 100000.
Required: Yes
- RegistrationArn
-
The Amazon Resource Name (ARN) for the registration.
Type: String
Required: Yes
- RegistrationId
-
The unique identifier for the registration.
Type: String
Required: Yes
- 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
Valid Values:
CREATED | SUBMITTED | REVIEWING | REQUIRES_AUTHENTICATION | PROVISIONING | COMPLETE | REQUIRES_UPDATES | CLOSED | DELETEDRequired: Yes
-
- 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_]+Required: Yes
- AdditionalAttributes
-
Metadata about a given registration which is specific to that registration type.
Type: String to string map
Required: No
- ApprovedVersionNumber
-
The version number of the registration that was approved.
Type: Long
Valid Range: Minimum value of 1. Maximum value of 100000.
Required: No
- LatestDeniedVersionNumber
-
The latest version number of the registration that was denied.
Type: Long
Valid Range: Minimum value of 1. Maximum value of 100000.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
