Skip to content

describe_flywheel

describe_flywheel(
    flywheel_arn: ComprehendFlywheelArn,
    *,
    config_overrides: Optional[ComprehendClientConfig] = None,
) -> DescribeFlywheelResponse

Provides configuration information about the flywheel. 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(
    self,
    flywheel_arn: "capo_comprehend.types.comprehend_flywheel_arn.ComprehendFlywheelArn",
    *,
    config_overrides: Optional[ComprehendClientConfig] = None,
) -> "capo_comprehend.types.describe_flywheel_response.DescribeFlywheelResponse":
    """<p>Provides configuration information about the flywheel. 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 Amazon Resource Number (ARN) of the flywheel.</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_request.DescribeFlywheelRequest]",
    ) -> OperationResponse[
        "capo_comprehend.types.describe_flywheel_response.DescribeFlywheelResponse"
    ]:
        import capo_comprehend._operations.comprehend_20171127.describe_flywheel

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeFlywheel")
    )
    input_: capo_comprehend.types.describe_flywheel_request.DescribeFlywheelRequest = {
        "flywheel_arn": flywheel_arn
    }

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