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

**************
delete_keyword
**************



.. py:method:: PinpointSMSVoiceV2.Client.delete_keyword(**kwargs)

  

  Deletes an existing keyword from an origination phone number or pool.

   

  A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, End User Messaging SMS responds with a customizable message.

   

  Keywords "HELP" and "STOP" can't be deleted or modified.

  

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


  **Request Syntax**
  ::

    response = client.delete_keyword(
        OriginationIdentity='string',
        Keyword='string'
    )
    
  :type OriginationIdentity: string
  :param OriginationIdentity: **[REQUIRED]** 

    The origination identity to use such as a PhoneNumberId, PhoneNumberArn, PoolId or PoolArn. You can use  DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn and  DescribePools to find the values of PoolId and PoolArn.

     

    .. warning::

       

      If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).

      

    

  
  :type Keyword: string
  :param Keyword: **[REQUIRED]** 

    The keyword to delete.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'OriginationIdentityArn': 'string',
          'OriginationIdentity': 'string',
          'Keyword': 'string',
          'KeywordMessage': 'string',
          'KeywordAction': 'AUTOMATIC_RESPONSE'|'OPT_OUT'|'OPT_IN'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **OriginationIdentityArn** *(string) --* 

        The PhoneNumberArn or PoolArn that the keyword was associated with.

        
      

      - **OriginationIdentity** *(string) --* 

        The PhoneNumberId or PoolId that the keyword was associated with.

        
      

      - **Keyword** *(string) --* 

        The keyword that was deleted.

        
      

      - **KeywordMessage** *(string) --* 

        The message that was associated with the deleted keyword.

        
      

      - **KeywordAction** *(string) --* 

        The action that was associated with the deleted keyword.

        
  
  **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`

  