Skip to content
AWS for Query.Farm

aws.comprehend.describe_endpoint

Example SQL Queries

SELECT * FROM
aws.comprehend.describe_endpoint
WHERE
"endpoint_arn" = 'VALUE';

Description

Gets the properties associated with a specific endpoint. Use this operation to get the status of an endpoint. For information about endpoints, see Managing endpoints.

Table Definition

Column NameColumn Data Type
endpoint_arn Required Input Column

The Amazon Resource Number (ARN) of the endpoint being described.

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.

_aws_region Input Column

The AWS region to use.

VARCHAR
endpoint_properties

Describes information associated with the specific endpoint.

STRUCT(
    "endpoint_arn" VARCHAR,
    "status" VARCHAR,
    "message" VARCHAR,
    "model_arn" VARCHAR,
    "desired_model_arn" VARCHAR,
    "desired_inference_units" BIGINT,
    "current_inference_units" BIGINT,
    "creation_time" TIMESTAMP_S,
    "last_modified_time" TIMESTAMP_S,
    "data_access_role_arn" VARCHAR,
    "desired_data_access_role_arn" VARCHAR,
    "flywheel_arn" VARCHAR
)
Show child fields
endpoint_properties.creation_time

The creation date and time of the endpoint.

endpoint_properties.current_inference_units

The number of inference units currently used by the model using this endpoint.

endpoint_properties.data_access_role_arn

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).

endpoint_properties.desired_data_access_role_arn

Data access role ARN to use in case the new model is encrypted with a customer KMS key.

endpoint_properties.desired_inference_units

The desired number of inference units to be used by the model using this endpoint. Each inference unit represents of a throughput of 100 characters per second.

endpoint_properties.desired_model_arn

ARN of the new model to use for updating an existing endpoint. This ARN is going to be different from the model ARN when the update is in progress

endpoint_properties.endpoint_arn

The Amazon Resource Number (ARN) of the endpoint.

endpoint_properties.flywheel_arn

The Amazon Resource Number (ARN) of the flywheel

endpoint_properties.last_modified_time

The date and time that the endpoint was last modified.

endpoint_properties.message

Specifies a reason for failure in cases of Failed status.

endpoint_properties.model_arn

The Amazon Resource Number (ARN) of the model to which the endpoint is attached.

endpoint_properties.status

Specifies the status of the endpoint. Because the endpoint updates and creation are asynchronous, so customers will need to wait for the endpoint to be Ready status before making inference requests.