Describe Endpoint

comprehend_describe_endpoint

R Documentation

Gets the properties associated with a specific endpoint

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.

Usage

comprehend_describe_endpoint(EndpointArn)

Arguments

EndpointArn

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

Value

A list with the following syntax:

list(
  EndpointProperties = list(
    EndpointArn = "string",
    Status = "CREATING"|"DELETING"|"FAILED"|"IN_SERVICE"|"UPDATING",
    Message = "string",
    ModelArn = "string",
    DesiredModelArn = "string",
    DesiredInferenceUnits = 123,
    CurrentInferenceUnits = 123,
    CreationTime = as.POSIXct(
      "2015-01-01"
    ),
    LastModifiedTime = as.POSIXct(
      "2015-01-01"
    ),
    DataAccessRoleArn = "string",
    DesiredDataAccessRoleArn = "string",
    FlywheelArn = "string"
  )
)

Request syntax

svc$describe_endpoint(
  EndpointArn = "string"
)