:doc:`Comprehend <../../comprehend>` / Client / list_flywheels

**************
list_flywheels
**************



.. py:method:: Comprehend.Client.list_flywheels(**kwargs)

  

  Gets a list of the flywheels that you have created.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListFlywheels>`_  


  **Request Syntax**
  ::

    response = client.list_flywheels(
        Filter={
            'Status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED',
            'CreationTimeAfter': datetime(2015, 1, 1),
            'CreationTimeBefore': datetime(2015, 1, 1)
        },
        NextToken='string',
        MaxResults=123
    )
    
  :type Filter: dict
  :param Filter: 

    Filters the flywheels that are returned. You can filter flywheels on their status, or the date and time that they were submitted. You can only set one filter at a time.

    

  
    - **Status** *(string) --* 

      Filter the flywheels based on the flywheel status.

      

    
    - **CreationTimeAfter** *(datetime) --* 

      Filter the flywheels to include flywheels created after the specified time.

      

    
    - **CreationTimeBefore** *(datetime) --* 

      Filter the flywheels to include flywheels created before the specified time.

      

    
  
  :type NextToken: string
  :param NextToken: 

    Identifies the next page of results to return.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    Maximum number of results to return in a response. The default is 100.

    

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

    
    ::

      {
          'FlywheelSummaryList': [
              {
                  'FlywheelArn': 'string',
                  'ActiveModelArn': 'string',
                  'DataLakeS3Uri': 'string',
                  'Status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED',
                  'ModelType': 'DOCUMENT_CLASSIFIER'|'ENTITY_RECOGNIZER',
                  'Message': 'string',
                  'CreationTime': datetime(2015, 1, 1),
                  'LastModifiedTime': datetime(2015, 1, 1),
                  'LatestFlywheelIteration': 'string'
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **FlywheelSummaryList** *(list) --* 

        A list of flywheel properties retrieved by the service in response to the request.

        
        

        - *(dict) --* 

          Flywheel summary information.

          
          

          - **FlywheelArn** *(string) --* 

            The Amazon Resource Number (ARN) of the flywheel

            
          

          - **ActiveModelArn** *(string) --* 

            ARN of the active model version for the flywheel.

            
          

          - **DataLakeS3Uri** *(string) --* 

            Amazon S3 URI of the data lake location.

            
          

          - **Status** *(string) --* 

            The status of the flywheel.

            
          

          - **ModelType** *(string) --* 

            Model type of the flywheel's model.

            
          

          - **Message** *(string) --* 

            A description of the status of the flywheel.

            
          

          - **CreationTime** *(datetime) --* 

            Creation time of the flywheel.

            
          

          - **LastModifiedTime** *(datetime) --* 

            Last modified time for the flywheel.

            
          

          - **LatestFlywheelIteration** *(string) --* 

            The most recent flywheel iteration.

            
      
    
      

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

        Identifies the next page of results to return.

        
  
  **Exceptions**
  
  *   :py:class:`Comprehend.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`Comprehend.Client.exceptions.TooManyRequestsException`

  
  *   :py:class:`Comprehend.Client.exceptions.InvalidFilterException`

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

  