list_unregistered_models

MachineLearningApi.list_unregistered_models(role_id, fields=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

List SageMaker models not registered as custom Amorphic models

Returns SageMaker model names that are not already custom Amorphic models (artifact-created ModelIds). Query parameter fields is accepted but ignored.

Parameters:

  • role_id (str) – Role identifier used for authorization. Missing this header returns AUTH-1001. (required)

  • fields (str) – Present in the API contract but ignored by this operation.

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

ModelsUnregistered

Returns:

Returns the result object.

Request and Response Examples

HTTP: GET /models/unregistered

Success (HTTP 200)

SageMaker model names that are not registered as custom Amorphic ModelIds.

Request / response example

{
  "models": [
    {
      "unregisteredModel": "marketplace-xgboost-model"
    }
  ]
}

Errors

Documented error codes: AUTH-1010, GE-1008.

HTTP 400

Invalid request or unauthorized caller.

Request / response example

{
  "Message": "AUTH-1010 - User jane.doe is not authorized to perform this operation"
}

HTTP 500

Unexpected failure while listing unregistered models (GE-1008).

Request / response example

{
  "Message": "GE-1008 - Could not complete the request. Please try again."
}