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

*****************
describe_keywords
*****************



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

  

  Describes the specified keywords or all keywords on your 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.

   

  If you specify a keyword that isn't valid, an error is returned.

  

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


  **Request Syntax**
  ::

    response = client.describe_keywords(
        OriginationIdentity='string',
        Keywords=[
            'string',
        ],
        Filters=[
            {
                'Name': 'keyword-action',
                'Values': [
                    'string',
                ]
            },
        ],
        NextToken='string',
        MaxResults=123
    )
    
  :type OriginationIdentity: string
  :param OriginationIdentity: **[REQUIRED]** 

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

     

    .. warning::

       

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

      

    

  
  :type Keywords: list
  :param Keywords: 

    An array of keywords to search for.

    

  
    - *(string) --* 

    

  :type Filters: list
  :param Filters: 

    An array of keyword filters to filter the results.

    

  
    - *(dict) --* 

      The information for keywords that meet a specified criteria.

      

    
      - **Name** *(string) --* **[REQUIRED]** 

        The name of the attribute to filter on.

        

      
      - **Values** *(list) --* **[REQUIRED]** 

        An array values to filter for.

        

      
        - *(string) --* 

        
    
    

  :type NextToken: string
  :param NextToken: 

    The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results to return per each request.

    

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

    
    ::

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

    

    - *(dict) --* 
      

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

        The PhoneNumberArn or PoolArn that is associated with the OriginationIdentity.

        
      

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

        The PhoneNumberId or PoolId that is associated with the OriginationIdentity.

        
      

      - **Keywords** *(list) --* 

        An array of KeywordInformation objects that contain the results.

        
        

        - *(dict) --* 

          The information for all keywords in a pool.

          
          

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

            The keyword as a string.

            
          

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

            A custom message that can be used with the keyword.

            
          

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

            The action to perform for the keyword.

            
      
    
      

      - **NextToken** *(string) --* 

        The token to be used for the next set of paginated results. If this field is empty then there are no more results.

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

  