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

CancelTrainedModel

Submits a request to cancel the trained model job.

Request Syntax


PATCH /memberships/membershipIdentifier/trained-models/trainedModelArn?versionIdentifier=versionIdentifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

membershipIdentifier

The membership ID of the trained model job that you want to cancel.

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

trainedModelArn

The Amazon Resource Name (ARN) of the trained model job that you want to cancel.

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_/.]+

Required: Yes

versionIdentifier

The version identifier of the trained model to cancel. This parameter allows you to specify which version of the trained model you want to cancel when multiple versions exist.

If versionIdentifier is not specified, the base model will be cancelled.

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

Response Elements

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

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

ConflictException

You can't complete this action because another resource depends on this resource.

HTTP Status Code: 409

ResourceNotFoundException

The resource you are requesting does not exist.

HTTP Status Code: 404

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