NeptuneData / Client / delete_ml_endpoint
delete_ml_endpoint#
- NeptuneData.Client.delete_ml_endpoint(**kwargs)#
Cancels the creation of a Neptune ML inference endpoint. See Managing inference endpoints using the endpoints command.
When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:DeleteMLEndpoint IAM action in that cluster.
See also: AWS API Documentation
Request Syntax
response = client.delete_ml_endpoint( id='string', neptuneIamRoleArn='string', clean=True|False )
- Parameters:
id (string) –
[REQUIRED]
The unique identifier of the inference endpoint.
neptuneIamRoleArn (string) – The ARN of an IAM role providing Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will be thrown.
clean (boolean) – If this flag is set to
TRUE
, all Neptune ML S3 artifacts should be deleted when the job is stopped. The default isFALSE
.
- Return type:
dict
- Returns:
Response Syntax
{ 'status': 'string' }
Response Structure
(dict) –
status (string) –
The status of the cancellation.
Exceptions
NeptuneData.Client.exceptions.UnsupportedOperationException
NeptuneData.Client.exceptions.BadRequestException
NeptuneData.Client.exceptions.MLResourceNotFoundException
NeptuneData.Client.exceptions.InvalidParameterException
NeptuneData.Client.exceptions.ClientTimeoutException
NeptuneData.Client.exceptions.PreconditionsFailedException
NeptuneData.Client.exceptions.ConstraintViolationException
NeptuneData.Client.exceptions.InvalidArgumentException
NeptuneData.Client.exceptions.MissingParameterException
NeptuneData.Client.exceptions.IllegalArgumentException
NeptuneData.Client.exceptions.TooManyRequestsException