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

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

Overview

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)


1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
# File '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_arnString

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)


1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
# File '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_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)


1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
# File '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_nameString

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

Returns:

  • (String)


1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
# File '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_arnString

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

Returns:

  • (String)


1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
# File '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_arnString

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

Returns:

  • (String)


1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
# File '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

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



1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
# File '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