Table Of Contents


User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . comprehend ]



Gets a list of all existing endpoints that you've created.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


[--filter <value>]
[--next-token <value>]
[--max-results <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--filter (structure)

Filters the endpoints that are returned. You can filter endpoints on their name, model, status, or the date and time that they were created. You can only set one filter at a time.

Shorthand Syntax:


JSON Syntax:

  "ModelArn": "string",
  "CreationTimeBefore": timestamp,
  "CreationTimeAfter": timestamp

--next-token (string)

Identifies the next page of results to return.

--max-results (integer)

The maximum number of results to return in each page. The default is 100.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.


EndpointPropertiesList -> (list)

Displays a list of endpoint properties being retrieved by the service in response to the request.


Specifies information about the specified endpoint.

EndpointArn -> (string)

The Amazon Resource Number (ARN) of the endpoint.

Status -> (string)

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.

Message -> (string)

Specifies a reason for failure in cases of Failed status.

ModelArn -> (string)

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

DesiredInferenceUnits -> (integer)

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.

CurrentInferenceUnits -> (integer)

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

CreationTime -> (timestamp)

The creation date and time of the endpoint.

LastModifiedTime -> (timestamp)

The date and time that the endpoint was last modified.

NextToken -> (string)

Identifies the next page of results to return.