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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb

Overview

Note:

When making an API call, you may pass CreateEndpointRequest data as a hash:

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

Constant Summary collapse

SENSITIVE =
[]

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.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


826
827
828
829
830
831
832
833
834
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 826

class CreateEndpointRequest < Struct.new(
  :endpoint_name,
  :model_arn,
  :desired_inference_units,
  :client_request_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#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)


826
827
828
829
830
831
832
833
834
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 826

class CreateEndpointRequest < Struct.new(
  :endpoint_name,
  :model_arn,
  :desired_inference_units,
  :client_request_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_nameString

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

Returns:

  • (String)


826
827
828
829
830
831
832
833
834
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 826

class CreateEndpointRequest < Struct.new(
  :endpoint_name,
  :model_arn,
  :desired_inference_units,
  :client_request_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#model_arnString

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

Returns:

  • (String)


826
827
828
829
830
831
832
833
834
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 826

class CreateEndpointRequest < Struct.new(
  :endpoint_name,
  :model_arn,
  :desired_inference_units,
  :client_request_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#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:



826
827
828
829
830
831
832
833
834
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 826

class CreateEndpointRequest < Struct.new(
  :endpoint_name,
  :model_arn,
  :desired_inference_units,
  :client_request_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end