:doc:`PinpointSMSVoiceV2 <../../pinpoint-sms-voice-v2>` / Client / delete_opt_out_list

*******************
delete_opt_out_list
*******************



.. py:method:: 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.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/DeleteOptOutList>`_  


  **Request Syntax**
  ::

    response = client.delete_opt_out_list(
        OptOutListName='string'
    )
    
  :type OptOutListName: string
  :param OptOutListName: **[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 End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).

      

    

  
  
  :rtype: 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 <https://www.epochconverter.com/>`__ format.

        
  
  **Exceptions**
  
  *   :py:class:`PinpointSMSVoiceV2.Client.exceptions.ThrottlingException`

  
  *   :py:class:`PinpointSMSVoiceV2.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`PinpointSMSVoiceV2.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`PinpointSMSVoiceV2.Client.exceptions.ValidationException`

  
  *   :py:class:`PinpointSMSVoiceV2.Client.exceptions.ConflictException`

  
  *   :py:class:`PinpointSMSVoiceV2.Client.exceptions.InternalServerException`

  