NeptuneData / Client / get_ml_endpoint

get_ml_endpoint#

NeptuneData.Client.get_ml_endpoint(**kwargs)#

Retrieves details about an 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:GetMLEndpointStatus IAM action in that cluster.

Request Syntax

response = client.get_ml_endpoint(
    id='string',
    neptuneIamRoleArn='string'
)

Parameters:

id (string) –
[REQUIRED]

The unique identifier of the inference endpoint.
neptuneIamRoleArn (string) – The ARN of an IAM role that provides Neptune access to SageMaker and Amazon S3 resources. This must be listed in your DB cluster parameter group or an error will occur.

Return type:

dict

Returns:

Response Syntax

{
    'status': 'string',
    'id': 'string',
    'endpoint': {
        'name': 'string',
        'arn': 'string',
        'status': 'string',
        'outputLocation': 'string',
        'failureReason': 'string',
        'cloudwatchLogUrl': 'string'
    },
    'endpointConfig': {
        'name': 'string',
        'arn': 'string'
    }
}

Response Structure

(dict) –
- status (string) –
  
  The status of the inference endpoint.
- id (string) –
  
  The unique identifier of the inference endpoint.
- endpoint (dict) –
  
  The endpoint definition.
  - name (string) –
    
    The resource name.
  - arn (string) –
    
    The resource ARN.
  - status (string) –
    
    The resource status.
  - outputLocation (string) –
    
    The output location.
  - failureReason (string) –
    
    The failure reason, in case of a failure.
  - cloudwatchLogUrl (string) –
    
    The CloudWatch log URL for the resource.
- endpointConfig (dict) –
  
  The endpoint configuration
  - name (string) –
    
    The configuration name.
  - arn (string) –
    
    The ARN for the configuration.

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