Skip to content

get_trained_model async

get_trained_model(
    trained_model_arn: TrainedModelArn,
    membership_identifier: UUID,
    *,
    config_overrides: Optional[AsyncCleanRoomsMLClientConfig] = None,
    version_identifier: Optional[UUID] = None,
) -> GetTrainedModelResponse

Returns information about a trained model.

Parameters:

  • trained_model_arn (TrainedModelArn) –

    The Amazon Resource Name (ARN) of the trained model that you are interested in.

  • membership_identifier (UUID) –

    The membership ID of the member that created the trained model that you are interested in.

  • version_identifier (Optional[UUID], default: None ) –

    The version identifier of the trained model to retrieve. If not specified, the operation returns information about the latest version of the trained model.

Raises:

Source code in docs_src/capo_cleanroomsml/_services/async_clean_rooms_ml.py
async def get_trained_model(
    self,
    trained_model_arn: "capo_cleanroomsml.types.trained_model_arn.TrainedModelArn",
    membership_identifier: "capo_cleanroomsml.types.uuid.UUID",
    *,
    config_overrides: Optional[AsyncCleanRoomsMLClientConfig] = None,
    version_identifier: Optional["capo_cleanroomsml.types.uuid.UUID"] = None,
) -> "capo_cleanroomsml.types.get_trained_model_response.GetTrainedModelResponse":
    """<p>Returns information about a trained model.</p>

    Args:
        trained_model_arn: <p>The Amazon Resource Name (ARN) of the trained model that you are interested in.</p>
        membership_identifier: <p>The membership ID of the member that created the trained model that you are interested in.</p>
        version_identifier: <p>The version identifier of the trained model to retrieve. If not specified, the operation returns information about the latest version of the trained model.</p>

    Raises:
        capo_cleanroomsml.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_cleanroomsml.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource you are requesting does not exist.</p>
        capo_cleanroomsml.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_cleanroomsml.errors.validation_exception.ValidationException: <p>The request parameters for this request are incorrect.</p>
        capo_cleanroomsml.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_cleanroomsml.types.get_trained_model_request.GetTrainedModelRequest]",
    ) -> AsyncOperationResponse[
        "capo_cleanroomsml.types.get_trained_model_response.GetTrainedModelResponse"
    ]:
        import capo_cleanroomsml._operations.aws_stark_control_service.get_trained_model

        (
            output,
            http_response,
        ) = await capo_cleanroomsml._operations.aws_stark_control_service.get_trained_model.async_get_trained_model(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetTrainedModel")
    )
    input_: capo_cleanroomsml.types.get_trained_model_request.GetTrainedModelRequest = {
        "trained_model_arn": trained_model_arn,
        "membership_identifier": membership_identifier,
    }
    if version_identifier is not None:
        input_["version_identifier"] = version_identifier

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