DescribeEndpointCommand

Suggest an Edit

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 .

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { ComprehendClient, DescribeEndpointCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
// const { ComprehendClient, DescribeEndpointCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
const client = new ComprehendClient(config);
const input = { // DescribeEndpointRequest
  EndpointArn: "STRING_VALUE", // required
};
const command = new DescribeEndpointCommand(input);
const response = await client.send(command);
// { // DescribeEndpointResponse
//   EndpointProperties: { // EndpointProperties
//     EndpointArn: "STRING_VALUE",
//     Status: "CREATING" || "DELETING" || "FAILED" || "IN_SERVICE" || "UPDATING",
//     Message: "STRING_VALUE",
//     ModelArn: "STRING_VALUE",
//     DesiredModelArn: "STRING_VALUE",
//     DesiredInferenceUnits: Number("int"),
//     CurrentInferenceUnits: Number("int"),
//     CreationTime: new Date("TIMESTAMP"),
//     LastModifiedTime: new Date("TIMESTAMP"),
//     DataAccessRoleArn: "STRING_VALUE",
//     DesiredDataAccessRoleArn: "STRING_VALUE",
//     FlywheelArn: "STRING_VALUE",
//   },
// };

DescribeEndpointCommand Input

See DescribeEndpointCommandInput for more details

Parameter
Type
Description
EndpointArn
Required
string | undefined

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

DescribeEndpointCommand Output

See DescribeEndpointCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
EndpointProperties
EndpointProperties | undefined

Describes information associated with the specific endpoint.

Throws

Name
Fault
Details
InternalServerException
server

An internal server error occurred. Retry your request.

InvalidRequestException
client

The request is invalid.

ResourceNotFoundException
client

The specified resource ARN was not found. Check the ARN and try your request again.

TooManyRequestsException
client

The number of requests exceeds the limit. Resubmit your request later.

ComprehendServiceException
Base exception class for all service exceptions from Comprehend service.