Disassociate Origination Identity

pinpointsmsvoicev2_disassociate_origination_identity

R Documentation

Removes the specified origination identity from an existing pool

Description

Removes the specified origination identity from an existing pool.

If the origination identity isn't associated with the specified pool, an error is returned.

Usage

pinpointsmsvoicev2_disassociate_origination_identity(PoolId,
  OriginationIdentity, IsoCountryCode, ClientToken)

Arguments

PoolId	[required] The unique identifier for the pool to disassociate with the origination identity. This value can be either the PoolId or PoolArn. If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).
OriginationIdentity	[required] The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use describe_phone_numbers find the values for PhoneNumberId and PhoneNumberArn, or use describe_sender_ids to get the values for SenderId and SenderIdArn. If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).
IsoCountryCode	The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. This field is optional and is not required for origination identity types that are not country-specific, such as RCS agents.
ClientToken	Unique, case-sensitive identifier 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$disassociate_origination_identity(
  PoolId = "string",
  OriginationIdentity = "string",
  IsoCountryCode = "string",
  ClientToken = "string"
)