AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::LookoutforVision::Types::StartModelRequest

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

Overview

Note:

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

{
  project_name: "ProjectName", # required
  model_version: "ModelVersion", # required
  min_inference_units: 1, # required
  client_token: "ClientToken",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

ClientToken is an idempotency token that ensures a call to StartModel completes only once. You choose the value to pass. For example, An issue, such as an network outage, might prevent you from getting a response from StartModel. In this case, safely retry your call to StartModel by using the same ClientToken parameter value. An error occurs if the other input parameters are not the same as in the first request. Using a different value for ClientToken is considered a new call to StartModel. An idempotency token is active for 8 hours.

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

Returns:

  • (String)


1446
1447
1448
1449
1450
1451
1452
1453
# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/types.rb', line 1446

class StartModelRequest < Struct.new(
  :project_name,
  :model_version,
  :min_inference_units,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#min_inference_unitsInteger

The minimum number of inference units to use. A single inference unit represents 1 hour of processing and can support up to 5 Transaction Pers Second (TPS). Use a higher number to increase the TPS throughput of your model. You are charged for the number of inference units that you use.

Returns:

  • (Integer)


1446
1447
1448
1449
1450
1451
1452
1453
# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/types.rb', line 1446

class StartModelRequest < Struct.new(
  :project_name,
  :model_version,
  :min_inference_units,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#model_versionString

The version of the model that you want to start.

Returns:

  • (String)


1446
1447
1448
1449
1450
1451
1452
1453
# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/types.rb', line 1446

class StartModelRequest < Struct.new(
  :project_name,
  :model_version,
  :min_inference_units,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#project_nameString

The name of the project that contains the model that you want to start.

Returns:

  • (String)


1446
1447
1448
1449
1450
1451
1452
1453
# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/types.rb', line 1446

class StartModelRequest < Struct.new(
  :project_name,
  :model_version,
  :min_inference_units,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end