PinpointSMSVoiceV2 / Client / disassociate_origination_identity

disassociate_origination_identity#

PinpointSMSVoiceV2.Client.disassociate_origination_identity(**kwargs)#

Removes the specified origination identity from an existing pool.

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

Request Syntax

response = client.disassociate_origination_identity(
    PoolId='string',
    OriginationIdentity='string',
    IsoCountryCode='string',
    ClientToken='string'
)

Parameters:

PoolId (string) –
[REQUIRED]

The unique identifier for the pool to disassociate with the origination identity. This value can be either the PoolId or PoolArn.

Warning
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
OriginationIdentity (string) –
[REQUIRED]

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

Warning
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
IsoCountryCode (string) –
[REQUIRED]

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
ClientToken (string) –
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.

This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'PoolArn': 'string',
    'PoolId': 'string',
    'OriginationIdentityArn': 'string',
    'OriginationIdentity': 'string',
    'IsoCountryCode': 'string'
}

Response Structure

(dict) –
- PoolArn (string) –
  
  The Amazon Resource Name (ARN) of the pool.
- PoolId (string) –
  
  The PoolId of the pool no longer associated with the origination identity.
- OriginationIdentityArn (string) –
  
  The PhoneNumberArn or SenderIdArn of the origination identity.
- OriginationIdentity (string) –
  
  The PhoneNumberId or SenderId of the origination identity.
- IsoCountryCode (string) –
  
  The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

Exceptions

PinpointSMSVoiceV2.Client.exceptions.ThrottlingException
PinpointSMSVoiceV2.Client.exceptions.AccessDeniedException
PinpointSMSVoiceV2.Client.exceptions.ResourceNotFoundException
PinpointSMSVoiceV2.Client.exceptions.ValidationException
PinpointSMSVoiceV2.Client.exceptions.ConflictException
PinpointSMSVoiceV2.Client.exceptions.InternalServerException