Skip to content

describe_flywheel_iteration

describe_flywheel_iteration(
    flywheel_arn: ComprehendFlywheelArn,
    flywheel_iteration_id: FlywheelIterationId,
    *,
    config_overrides: Optional[ComprehendClientConfig] = None,
) -> DescribeFlywheelIterationResponse

Retrieve the configuration properties of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.

Parameters:

Raises:

Source code in docs_src/capo_comprehend/_services/comprehend.py
def describe_flywheel_iteration(
    self,
    flywheel_arn: "capo_comprehend.types.comprehend_flywheel_arn.ComprehendFlywheelArn",
    flywheel_iteration_id: "capo_comprehend.types.flywheel_iteration_id.FlywheelIterationId",
    *,
    config_overrides: Optional[ComprehendClientConfig] = None,
) -> "capo_comprehend.types.describe_flywheel_iteration_response.DescribeFlywheelIterationResponse":
    """<p>Retrieve the configuration properties of a flywheel iteration. 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></p>
        flywheel_iteration_id: <p></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_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.describe_flywheel_iteration_request.DescribeFlywheelIterationRequest]",
    ) -> OperationResponse[
        "capo_comprehend.types.describe_flywheel_iteration_response.DescribeFlywheelIterationResponse"
    ]:
        import capo_comprehend._operations.comprehend_20171127.describe_flywheel_iteration

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeFlywheelIteration")
    )
    input_: capo_comprehend.types.describe_flywheel_iteration_request.DescribeFlywheelIterationRequest = {
        "flywheel_arn": flywheel_arn,
        "flywheel_iteration_id": flywheel_iteration_id,
    }

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