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

************
list_imports
************



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

  

  Lists the imports for a bot, bot locale, or custom vocabulary. Imports are kept in the list for 7 days.

  

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


  **Request Syntax**
  ::

    response = client.list_imports(
        botId='string',
        botVersion='string',
        sortBy={
            'attribute': 'LastUpdatedDateTime',
            'order': 'Ascending'|'Descending'
        },
        filters=[
            {
                'name': 'ImportResourceType',
                'values': [
                    'string',
                ],
                'operator': 'CO'|'EQ'
            },
        ],
        maxResults=123,
        nextToken='string',
        localeId='string'
    )
    
  :type botId: string
  :param botId: 

    The unique identifier that Amazon Lex assigned to the bot.

    

  
  :type botVersion: string
  :param botVersion: 

    The version of the bot to list imports for.

    

  
  :type sortBy: dict
  :param sortBy: 

    Determines the field that the list of imports is sorted by. You can sort by the ``LastUpdatedDateTime`` field in ascending or descending order.

    

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

      The export field to use for sorting.

      

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

      The order to sort the list.

      

    
  
  :type filters: list
  :param filters: 

    Provides the specification of a filter used to limit the bots in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.

    

  
    - *(dict) --* 

      Filters the response from the `ListImports <https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListImports.html>`__ operation.

      

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

        The name of the field to use for filtering.

        

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

        The values to use to filter the response. The values must be ``Bot``, ``BotLocale``, or ``CustomVocabulary``.

        

      
        - *(string) --* 

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

        The operator to use for the filter. Specify EQ when the ``ListImports`` operation should return only resource types that equal the specified value. Specify CO when the ``ListImports`` operation should return resource types that contain the specified value.

        

      
    

  :type maxResults: integer
  :param maxResults: 

    The maximum number of imports to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

    

  
  :type nextToken: string
  :param nextToken: 

    If the response from the ``ListImports`` operation contains more results than specified in the ``maxResults`` parameter, a token is returned in the response.

     

    Use the returned token in the ``nextToken`` parameter of a ``ListImports`` request to return the next page of results. For a complete set of results, call the ``ListImports`` operation until the ``nextToken`` returned in the response is null.

    

  
  :type localeId: string
  :param localeId: 

    Specifies the locale that should be present in the list. If you don't specify a resource type in the ``filters`` parameter, the list contains both bot locales and custom vocabularies.

    

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

    
    ::

      {
          'botId': 'string',
          'botVersion': 'string',
          'importSummaries': [
              {
                  'importId': 'string',
                  'importedResourceId': 'string',
                  'importedResourceName': 'string',
                  'importStatus': 'InProgress'|'Completed'|'Failed'|'Deleting',
                  'mergeStrategy': 'Overwrite'|'FailOnConflict'|'Append',
                  'creationDateTime': datetime(2015, 1, 1),
                  'lastUpdatedDateTime': datetime(2015, 1, 1),
                  'importedResourceType': 'Bot'|'BotLocale'|'CustomVocabulary'|'TestSet'
              },
          ],
          'nextToken': 'string',
          'localeId': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The unique identifier assigned by Amazon Lex to the bot.

        
      

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

        The version of the bot that was imported. It will always be ``DRAFT``.

        
      

      - **importSummaries** *(list) --* 

        Summary information for the imports that meet the filter criteria specified in the request. The length of the list is specified in the ``maxResults`` parameter. If there are more imports available, the ``nextToken`` field contains a token to get the next page of results.

        
        

        - *(dict) --* 

          Provides summary information about an import in an import list.

          
          

          - **importId** *(string) --* 

            The unique identifier that Amazon Lex assigned to the import.

            
          

          - **importedResourceId** *(string) --* 

            The unique identifier that Amazon Lex assigned to the imported resource.

            
          

          - **importedResourceName** *(string) --* 

            The name that you gave the imported resource.

            
          

          - **importStatus** *(string) --* 

            The status of the resource. When the status is ``Completed`` the resource is ready to build.

            
          

          - **mergeStrategy** *(string) --* 

            The strategy used to merge existing bot or bot locale definitions with the imported definition.

            
          

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

            The date and time that the import was created.

            
          

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

            The date and time that the import was last updated.

            
          

          - **importedResourceType** *(string) --* 

            The type of resource that was imported.

            
      
    
      

      - **nextToken** *(string) --* 

        A token that indicates whether there are more results to return in a response to the ``ListImports`` operation. If the ``nextToken`` field is present, you send the contents as the ``nextToken`` parameter of a ``ListImports`` operation request to get the next page of results.

        
      

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

        The locale specified in the request.

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

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

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

  