describe_model `async` ¶

describe_model(
    model_name: ModelName,
    *,
    config_overrides: Optional[AsyncLookoutEquipmentClientConfig] = None,
) -> DescribeModelResponse

Provides a JSON containing the overall information about a specific machine learning model, including model name and ARN, dataset, training and evaluation information, status, and so on.

Parameters:

model_name (ModelName) –

The name of the machine learning model to be described.

Raises:

AccessDeniedException –

The request could not be completed because you do not have access to the resource.
InternalServerException –

Processing of the request has failed because of an unknown error, exception or failure.
ResourceNotFoundException –

The resource requested could not be found. Verify the resource ID and retry your request.
ThrottlingException –

The request was denied due to request throttling.
ValidationException –

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_lookoutequipment/_services/async_lookout_equipment.py

async def describe_model(
    self,
    model_name: "capo_lookoutequipment.types.model_name.ModelName",
    *,
    config_overrides: Optional[AsyncLookoutEquipmentClientConfig] = None,
) -> "capo_lookoutequipment.types.describe_model_response.DescribeModelResponse":
    """<p>Provides a JSON containing the overall information about a specific machine learning model, including model name and ARN, dataset, training and evaluation information, status, and so on. </p>

    Args:
        model_name: <p>The name of the machine learning model to be described. </p>

    Raises:
        capo_lookoutequipment.errors.access_denied_exception.AccessDeniedException: <p>The request could not be completed because you do not have access to the resource. </p>
        capo_lookoutequipment.errors.internal_server_exception.InternalServerException: <p> Processing of the request has failed because of an unknown error, exception or failure. </p>
        capo_lookoutequipment.errors.resource_not_found_exception.ResourceNotFoundException: <p> The resource requested could not be found. Verify the resource ID and retry your request. </p>
        capo_lookoutequipment.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_lookoutequipment.errors.validation_exception.ValidationException: <p> The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized. </p>
        capo_lookoutequipment.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_lookoutequipment.types.describe_model_request.DescribeModelRequest]",
    ) -> AsyncOperationResponse[
        "capo_lookoutequipment.types.describe_model_response.DescribeModelResponse"
    ]:
        import capo_lookoutequipment._operations.aws_lookout_equipment_frontend_service.describe_model

        (
            output,
            http_response,
        ) = await capo_lookoutequipment._operations.aws_lookout_equipment_frontend_service.describe_model.async_describe_model(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeModel")
    )
    input_: capo_lookoutequipment.types.describe_model_request.DescribeModelRequest = {
        "model_name": model_name
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

describe_model async ¶

describe_model `async` ¶