Associate Origination Identity

pinpointsmsvoicev2_associate_origination_identity

R Documentation

Associates the specified origination identity with a pool¶

Description¶

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.

Usage¶

pinpointsmsvoicev2_associate_origination_identity(PoolId,
  OriginationIdentity, IsoCountryCode, ClientToken)

Arguments¶

PoolId: [required] The pool to update with the new Identity. This value can be either the PoolId or PoolArn, and you can find these values using describe_pools.
OriginationIdentity: [required] The origination identity to use, such as PhoneNumberId, PhoneNumberArn, SenderId, or SenderIdArn. You can use describe_phone_numbers to find the values for PhoneNumberId and PhoneNumberArn, while describe_sender_ids can be used to get the values for SenderId and SenderIdArn.
IsoCountryCode: [required] The new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the origination identity.
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.

Value¶

A list with the following syntax:

list(
  PoolArn = "string",
  PoolId = "string",
  OriginationIdentityArn = "string",
  OriginationIdentity = "string",
  IsoCountryCode = "string"
)

Request syntax¶

svc$associate_origination_identity(
  PoolId = "string",
  OriginationIdentity = "string",
  IsoCountryCode = "string",
  ClientToken = "string"
)