start_flywheel_iteration ¶

def start_flywheel_iteration(
    self,
    flywheel_arn: "capo_comprehend.types.comprehend_flywheel_arn.ComprehendFlywheelArn",
    *,
    config_overrides: Optional[ComprehendClientConfig] = None,
    client_request_token: Optional[
        "capo_comprehend.types.client_request_token_string.ClientRequestTokenString"
    ] = None,
) -> "capo_comprehend.types.start_flywheel_iteration_response.StartFlywheelIterationResponse":
    """<p>Start the flywheel iteration.This operation uses any new datasets to train a new model version. For more information about flywheels, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html"> Flywheel overview</a> in the <i>Amazon Comprehend Developer Guide</i>.</p>

    Args:
        flywheel_arn: <p>The ARN of the flywheel.</p>
        client_request_token: <p>A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.</p>

    Raises:
        capo_comprehend.errors.internal_server_exception.InternalServerException: <p>An internal server error occurred. Retry your request.</p>
        capo_comprehend.errors.invalid_request_exception.InvalidRequestException: <p>The request is invalid.</p>
        capo_comprehend.errors.resource_in_use_exception.ResourceInUseException: <p>The specified resource name is already in use. Use a different name and try your request again.</p>
        capo_comprehend.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
        capo_comprehend.errors.too_many_requests_exception.TooManyRequestsException: <p>The number of requests exceeds the limit. Resubmit your request later.</p>
        capo_comprehend.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_comprehend.types.start_flywheel_iteration_request.StartFlywheelIterationRequest]",
    ) -> OperationResponse[
        "capo_comprehend.types.start_flywheel_iteration_response.StartFlywheelIterationResponse"
    ]:
        import capo_comprehend._operations.comprehend_20171127.start_flywheel_iteration

        output, http_response = (
            capo_comprehend._operations.comprehend_20171127.start_flywheel_iteration.start_flywheel_iteration(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartFlywheelIteration")
    )
    input_: capo_comprehend.types.start_flywheel_iteration_request.StartFlywheelIterationRequest = {
        "flywheel_arn": flywheel_arn
    }
    if client_request_token is not None:
        input_["client_request_token"] = client_request_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output