:doc:`LexModelsV2 <../../lexv2-models>` / Client / describe_custom_vocabulary_metadata

***********************************
describe_custom_vocabulary_metadata
***********************************



.. py:method:: LexModelsV2.Client.describe_custom_vocabulary_metadata(**kwargs)

  

  Provides metadata information about a custom vocabulary.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DescribeCustomVocabularyMetadata>`_  


  **Request Syntax**
  ::

    response = client.describe_custom_vocabulary_metadata(
        botId='string',
        botVersion='string',
        localeId='string'
    )
    
  :type botId: string
  :param botId: **[REQUIRED]** 

    The unique identifier of the bot that contains the custom vocabulary.

    

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

    The bot version of the bot to return metadata for.

    

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

    The locale to return the custom vocabulary information for. The locale must be ``en_GB``.

    

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

    
    ::

      {
          'botId': 'string',
          'botVersion': 'string',
          'localeId': 'string',
          'customVocabularyStatus': 'Ready'|'Deleting'|'Exporting'|'Importing'|'Creating',
          'creationDateTime': datetime(2015, 1, 1),
          'lastUpdatedDateTime': datetime(2015, 1, 1)
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **botId** *(string) --* 

        The identifier of the bot that contains the custom vocabulary.

        
      

      - **botVersion** *(string) --* 

        The version of the bot that contains the custom vocabulary to describe.

        
      

      - **localeId** *(string) --* 

        The locale that contains the custom vocabulary to describe.

        
      

      - **customVocabularyStatus** *(string) --* 

        The status of the custom vocabulary. If the status is ``Ready`` the custom vocabulary is ready to use.

        
      

      - **creationDateTime** *(datetime) --* 

        The date and time that the custom vocabulary was created.

        
      

      - **lastUpdatedDateTime** *(datetime) --* 

        The date and time that the custom vocabulary was last updated.

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

  
  *   :py:class:`LexModelsV2.Client.exceptions.ServiceQuotaExceededException`

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

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

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

  