Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

AssociateOriginationIdentity

Associates the specified origination identity with a pool.

If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools.

If the origination identity configuration doesn't match the pool's configuration, an error is returned.

Request Syntax


{
   "ClientToken": "string",
   "IsoCountryCode": "string",
   "OriginationIdentity": "string",
   "PoolId": "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

IsoCountryCode

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

Type: String

Length Constraints: Fixed length of 2.

Pattern: [A-Z]{2}

Required: Yes

OriginationIdentity

The origination identity to use, such as PhoneNumberId, PhoneNumberArn, SenderId, or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn, while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.

Important

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

Type: String

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

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

Required: Yes

PoolId

The pool to update with the new Identity. This value can be either the PoolId or PoolArn, and you can find these values using DescribePools.

Important

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

Type: String

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

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

Required: Yes

Response Syntax


{
   "IsoCountryCode": "string",
   "OriginationIdentity": "string",
   "OriginationIdentityArn": "string",
   "PoolArn": "string",
   "PoolId": "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}

OriginationIdentity

The PhoneNumberId or SenderId of the origination identity.

Type: String

OriginationIdentityArn

The PhoneNumberArn or SenderIdArn of the origination identity.

Type: String

PoolArn

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

Type: String

PoolId

The PoolId of the pool that is now associated with the origination identity.

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