You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Comprehend::Types::CreateEndpointRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateEndpointRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  endpoint_name: "ComprehendEndpointName", # required
  model_arn: "ComprehendModelArn", # required
  desired_inference_units: 1, # required
  client_request_token: "ClientRequestTokenString",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_tokenString

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

Returns:

  • (String)

    An idempotency token provided by the customer.

#desired_inference_unitsInteger

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.

Returns:

  • (Integer)

    The desired number of inference units to be used by the model using this endpoint.

#endpoint_nameString

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

Returns:

  • (String)

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

#model_arnString

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

Returns:

  • (String)

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

#tagsArray<Types::Tag>

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.

Returns:

  • (Array<Types::Tag>)

    Tags associated with the endpoint being created.