Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateRegistrationAssociation

Associate the registration with an origination identity such as a phone number or sender ID.

Request Syntax


{
   "RegistrationId": "string",
   "ResourceId": "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

ResourceId

The unique identifier for the origination identity. For example this could be a PhoneNumberId or SenderId.

Type: String

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

Pattern: [A-Za-z0-9_:/-]+

Required: Yes

Response Syntax


{
   "IsoCountryCode": "string",
   "PhoneNumber": "string",
   "RegistrationArn": "string",
   "RegistrationId": "string",
   "RegistrationType": "string",
   "ResourceArn": "string",
   "ResourceId": "string",
   "ResourceType": "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.

IsoCountryCode

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

Type: String

Length Constraints: Fixed length of 2.

Pattern: [A-Z]{2}

PhoneNumber

The phone number associated with the registration in E.164 format.

Type: String

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

Pattern: \+?[1-9][0-9]{1,18}

RegistrationArn

The Amazon Resource Name (ARN) for the registration.

Type: String

RegistrationId

The unique identifier for the registration.

Type: String

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_]+

ResourceArn

The Amazon Resource Name (ARN) of the origination identity that is associated with the registration.

Type: String

ResourceId

The unique identifier for the origination identity. For example this could be a PhoneNumberId or SenderId.

Type: String

ResourceType

The registration type or origination identity type.

Type: String

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