Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListCollaborationTrainedModelInferenceJobs

Returns a list of trained model inference jobs in a specified collaboration.

Request Syntax


GET /collaborations/collaborationIdentifier/trained-model-inference-jobs?maxResults=maxResults&nextToken=nextToken&trainedModelArn=trainedModelArn&trainedModelVersionIdentifier=trainedModelVersionIdentifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

collaborationIdentifier

The collaboration ID of the collaboration that contains the trained model inference jobs that you are interested in.

Length Constraints: Fixed length of 36.

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes

maxResults

The maximum size of the results that is returned per call.

Valid Range: Minimum value of 1. Maximum value of 100.

nextToken

The token value retrieved from a previous call to access the next page of results.

Length Constraints: Minimum length of 1. Maximum length of 10240.

trainedModelArn

The Amazon Resource Name (ARN) of the trained model that was used to create the trained model inference jobs that you are interested in.

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws[-a-z]*:cleanrooms-ml:[-a-z0-9]+:[0-9]{12}:membership/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/trained-model/[-a-zA-Z0-9_/.]+

trainedModelVersionIdentifier

The version identifier of the trained model to filter inference jobs by. When specified, only inference jobs that used this specific version of the trained model are returned.

Length Constraints: Fixed length of 36.

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "collaborationTrainedModelInferenceJobs": [ 
      { 
         "collaborationIdentifier": "string",
         "configuredModelAlgorithmAssociationArn": "string",
         "createTime": "string",
         "creatorAccountId": "string",
         "description": "string",
         "logsStatus": "string",
         "logsStatusDetails": "string",
         "membershipIdentifier": "string",
         "metricsStatus": "string",
         "metricsStatusDetails": "string",
         "name": "string",
         "outputConfiguration": { 
            "accept": "string",
            "members": [ 
               { 
                  "accountId": "string"
               }
            ]
         },
         "status": "string",
         "trainedModelArn": "string",
         "trainedModelInferenceJobArn": "string",
         "trainedModelVersionIdentifier": "string",
         "updateTime": "string"
      }
   ],
   "nextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

collaborationTrainedModelInferenceJobs

The trained model inference jobs that you are interested in.

Type: Array of CollaborationTrainedModelInferenceJobSummary objects

nextToken

The token value used to access the next page of results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 10240.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The request parameters for this request are incorrect.

HTTP Status Code: 400