Skip to content
AWS for Query.Farm

aws.neptunedata.get_ml_endpoint

Example SQL Queries

SELECT * FROM
aws.neptunedata.get_ml_endpoint
WHERE
"id" = 'VALUE';

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.

Table Definition

Column NameColumn Data Type
id Required Input Column

The unique identifier of the inference endpoint.

VARCHAR
neptune_iam_role_arn Input Column

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.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

endpoint

The endpoint definition.

STRUCT(
    "name" VARCHAR,
    "arn" VARCHAR,
    "status" VARCHAR,
    "output_location" VARCHAR,
    "failure_reason" VARCHAR,
    "cloudwatch_log_url" VARCHAR
)
Show child fields
endpoint.arn

The resource ARN.

endpoint.cloudwatch_log_url

The CloudWatch log URL for the resource.

endpoint.failure_reason

The failure reason, in case of a failure.

endpoint.name

The resource name.

endpoint.output_location

The output location.

endpoint.status

The resource status.

endpoint_config

The endpoint configuration

STRUCT(
    "name" VARCHAR,
    "arn" VARCHAR
)
Show child fields
endpoint_config.arn

The ARN for the configuration.

endpoint_config.name

The configuration name.

status

The status of the inference endpoint.

VARCHAR