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

Inherits:

Struct

• Object
• Struct
• Aws::Comprehend::Types::CreateEndpointRequest

Defined in:

gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_request_token ⇒ String

  An idempotency token provided by the customer.

• #data_access_role_arn ⇒ String

  The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).

• #desired_inference_units ⇒ Integer

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

• #endpoint_name ⇒ String

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

• #flywheel_arn ⇒ String

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

• #model_arn ⇒ String

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

• #tags ⇒ Array<Types::Tag>

  Tags to associate with the endpoint.

Instance Attribute Details

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

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

Returns:

• (String)

# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 1195

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

#data_access_role_arn ⇒ String

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).

Returns:

• (String)

# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 1195

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

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

Returns:

• (Integer)

# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 1195

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

#endpoint_name ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 1195

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

#flywheel_arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 1195

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

#model_arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 1195

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

#tags ⇒ Array<Types::Tag>

Tags to associate with the endpoint. 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>)

# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 1195

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