PinpointSMSVoiceV2 / Client / delete_opt_out_list

delete_opt_out_list#

PinpointSMSVoiceV2.Client.delete_opt_out_list(**kwargs)#

Deletes an existing opt-out list. All opted out phone numbers in the opt-out list are deleted.

If the specified opt-out list name doesn’t exist or is in-use by an origination phone number or pool, an error is returned.

Request Syntax

response = client.delete_opt_out_list(
    OptOutListName='string'
)

Parameters:

OptOutListName (string) –

[REQUIRED]

The OptOutListName or OptOutListArn of the OptOutList to delete. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.

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).

Return type:

dict

Returns:

Response Syntax

{
    'OptOutListArn': 'string',
    'OptOutListName': 'string',
    'CreatedTimestamp': datetime(2015, 1, 1)
}

Response Structure

(dict) –
- OptOutListArn (string) –
  
  The Amazon Resource Name (ARN) of the OptOutList that was removed.
- OptOutListName (string) –
  
  The name of the OptOutList that was removed.
- CreatedTimestamp (datetime) –
  
  The time when the OptOutList was created, in UNIX epoch time format.

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