Table Of Contents


User Guide

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

[ aws . comprehend ]



Creates a model-specific endpoint for synchronous inference for a previously trained custom model

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--endpoint-name <value>
--model-arn <value>
--desired-inference-units <value>
[--client-request-token <value>]
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--endpoint-name (string)

This is the descriptive suffix that becomes part of the EndpointArn used for all subsequent requests to this resource.

--model-arn (string)

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

--desired-inference-units (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.

--client-request-token (string)

An idempotency token provided by the customer. If this token matches a previous endpoint creation request, Amazon Comprehend will not return a ResourceInUseException .

--tags (list)

Tags associated with the endpoint being created. A tag is a key-value pair that adds metadata to the endpoint. For example, a tag with "Sales" as the key might be added to an endpoint to indicate its use by the sales department.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

    "Key": "string",
    "Value": "string"

--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.


EndpointArn -> (string)

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