Skip to content

get_collaboration_trained_model

get_collaboration_trained_model(
    trained_model_arn: TrainedModelArn,
    collaboration_identifier: UUID,
    *,
    config_overrides: Optional[CleanRoomsMLClientConfig] = None,
    version_identifier: Optional[UUID] = None,
) -> GetCollaborationTrainedModelResponse

Returns information about a trained model in a collaboration.

Parameters:

  • trained_model_arn (TrainedModelArn) –

    The Amazon Resource Name (ARN) of the trained model that you want to return information about.

  • collaboration_identifier (UUID) –

    The collaboration ID that contains the trained model that you want to return information about.

  • 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/clean_rooms_ml.py
def get_collaboration_trained_model(
    self,
    trained_model_arn: "capo_cleanroomsml.types.trained_model_arn.TrainedModelArn",
    collaboration_identifier: "capo_cleanroomsml.types.uuid.UUID",
    *,
    config_overrides: Optional[CleanRoomsMLClientConfig] = None,
    version_identifier: Optional["capo_cleanroomsml.types.uuid.UUID"] = None,
) -> "capo_cleanroomsml.types.get_collaboration_trained_model_response.GetCollaborationTrainedModelResponse":
    """<p>Returns information about a trained model in a collaboration.</p>

    Args:
        trained_model_arn: <p>The Amazon Resource Name (ARN) of the trained model that you want to return information about.</p>
        collaboration_identifier: <p>The collaboration ID that contains the trained model that you want to return information about.</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.
    """

    def _handler(
        req: "OperationRequest[capo_cleanroomsml.types.get_collaboration_trained_model_request.GetCollaborationTrainedModelRequest]",
    ) -> OperationResponse[
        "capo_cleanroomsml.types.get_collaboration_trained_model_response.GetCollaborationTrainedModelResponse"
    ]:
        import capo_cleanroomsml._operations.aws_stark_control_service.get_collaboration_trained_model

        output, http_response = (
            capo_cleanroomsml._operations.aws_stark_control_service.get_collaboration_trained_model.get_collaboration_trained_model(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetCollaborationTrainedModel")
    )
    input_: capo_cleanroomsml.types.get_collaboration_trained_model_request.GetCollaborationTrainedModelRequest = {
        "trained_model_arn": trained_model_arn,
        "collaboration_identifier": collaboration_identifier,
    }
    if version_identifier is not None:
        input_["version_identifier"] = version_identifier

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