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

************************
start_flywheel_iteration
************************



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

  

  Start the flywheel iteration.This operation uses any new datasets to train a new model version. For more information about flywheels, see `Flywheel overview <https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html>`__ in the *Amazon Comprehend Developer Guide*.

  

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


  **Request Syntax**
  ::

    response = client.start_flywheel_iteration(
        FlywheelArn='string',
        ClientRequestToken='string'
    )
    
  :type FlywheelArn: string
  :param FlywheelArn: **[REQUIRED]** 

    The ARN of the flywheel.

    

  
  :type ClientRequestToken: string
  :param ClientRequestToken: 

    A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

    

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

    
    ::

      {
          'FlywheelArn': 'string',
          'FlywheelIterationId': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

      - **FlywheelIterationId** *(string) --* 
  
  **Exceptions**
  
  *   :py:class:`Comprehend.Client.exceptions.InvalidRequestException`

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

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

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

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

  