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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

ClientToken is an idempotency token that ensures a call to ‘StartModel` completes only once. You choose the value to pass. For example, An issue 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.

If you don’t supply a value for ‘ClientToken`, the AWS SDK you are using inserts a value for you. This prevents retries after a network error from making multiple start requests. You’ll need to provide your own value for other use cases.

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) 


1793
1794
1795
1796
1797
1798
1799
1800
1801
 
# File 'lib/aws-sdk-lookoutforvision/types.rb', line 1793

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

#max_inference_units ⇒ Integer

The maximum number of inference units to use for auto-scaling the model. If you don’t specify a value, Amazon Lookout for Vision doesn’t auto-scale the model.

Returns:

  • (Integer) 


1793
1794
1795
1796
1797
1798
1799
1800
1801
 
# File 'lib/aws-sdk-lookoutforvision/types.rb', line 1793

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

#min_inference_units ⇒ Integer

The minimum number of inference units to use. A single inference unit represents 1 hour of processing. 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) 


1793
1794
1795
1796
1797
1798
1799
1800
1801
 
# File 'lib/aws-sdk-lookoutforvision/types.rb', line 1793

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

#model_version ⇒ String

The version of the model that you want to start.

Returns:

  • (String) 


1793
1794
1795
1796
1797
1798
1799
1800
1801
 
# File 'lib/aws-sdk-lookoutforvision/types.rb', line 1793

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

#project_name ⇒ String

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

Returns:

  • (String) 


1793
1794
1795
1796
1797
1798
1799
1800
1801
 
# File 'lib/aws-sdk-lookoutforvision/types.rb', line 1793

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