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

***************
describe_export
***************



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

  

  Gets information about a specific export.

  

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


  **Request Syntax**
  ::

    response = client.describe_export(
        exportId='string'
    )
    
  :type exportId: string
  :param exportId: **[REQUIRED]** 

    The unique identifier of the export to describe.

    

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

    
    ::

      {
          'exportId': 'string',
          'resourceSpecification': {
              'botExportSpecification': {
                  'botId': 'string',
                  'botVersion': 'string'
              },
              'botLocaleExportSpecification': {
                  'botId': 'string',
                  'botVersion': 'string',
                  'localeId': 'string'
              },
              'customVocabularyExportSpecification': {
                  'botId': 'string',
                  'botVersion': 'string',
                  'localeId': 'string'
              },
              'testSetExportSpecification': {
                  'testSetId': 'string'
              }
          },
          'fileFormat': 'LexJson'|'TSV'|'CSV',
          'exportStatus': 'InProgress'|'Completed'|'Failed'|'Deleting',
          'failureReasons': [
              'string',
          ],
          'downloadUrl': 'string',
          'creationDateTime': datetime(2015, 1, 1),
          'lastUpdatedDateTime': datetime(2015, 1, 1)
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **exportId** *(string) --* 

        The unique identifier of the described export.

        
      

      - **resourceSpecification** *(dict) --* 

        The bot, bot ID, and optional locale ID of the exported bot or bot locale.

        
        

        - **botExportSpecification** *(dict) --* 

          Parameters for exporting a bot.

          
          

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

            The identifier of the bot assigned by Amazon Lex.

            
          

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

            The version of the bot that was exported. This will be either ``DRAFT`` or the version number.

            
      
        

        - **botLocaleExportSpecification** *(dict) --* 

          Parameters for exporting a bot locale.

          
          

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

            The identifier of the bot to create the locale for.

            
          

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

            The version of the bot to export.

            
          

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

            The identifier of the language and locale to export. The string must match one of the locales in the bot.

            
      
        

        - **customVocabularyExportSpecification** *(dict) --* 

          The parameters required to export a custom vocabulary.

          
          

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

            The identifier of the bot that contains the custom vocabulary to export.

            
          

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

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

            
          

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

            The locale of the bot that contains the custom vocabulary to export.

            
      
        

        - **testSetExportSpecification** *(dict) --* 

          Specifications for the test set that is exported as a resource.

          
          

          - **testSetId** *(string) --* 

            The unique identifier of the test set.

            
      
    
      

      - **fileFormat** *(string) --* 

        The file format used in the files that describe the resource.

        
      

      - **exportStatus** *(string) --* 

        The status of the export. When the status is ``Complete`` the export archive file is available for download.

        
      

      - **failureReasons** *(list) --* 

        If the ``exportStatus`` is failed, contains one or more reasons why the export could not be completed.

        
        

        - *(string) --* 
    
      

      - **downloadUrl** *(string) --* 

        A pre-signed S3 URL that points to the bot or bot locale archive. The URL is only available for 5 minutes after calling the ``DescribeExport`` operation.

        
      

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

        The date and time that the export was created.

        
      

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

        The last date and time that the export was updated.

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

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

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

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

  