Skip to content

Get Ml Endpoint

neptunedata_get_ml_endpoint R Documentation

Retrieves details about an inference endpoint

Description

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.

Usage

neptunedata_get_ml_endpoint(id, neptuneIamRoleArn)

Arguments

id

[required] The unique identifier of the inference endpoint.

neptuneIamRoleArn

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.

Value

A list with the following syntax: 

list(
  status = "string",
  id = "string",
  endpoint = list(
    name = "string",
    arn = "string",
    status = "string",
    outputLocation = "string",
    failureReason = "string",
    cloudwatchLogUrl = "string"
  ),
  endpointConfig = list(
    name = "string",
    arn = "string"
  )
)

Request syntax

svc$get_ml_endpoint(
  id = "string",
  neptuneIamRoleArn = "string"
)