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

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 CreateModelRequest data as a hash:

{
  project_name: "ProjectName", # required
  description: "ModelDescriptionMessage",
  client_token: "ClientToken",
  output_config: { # required
    s3_location: { # required
      bucket: "S3BucketName", # required
      prefix: "S3KeyPrefix",
    },
  },
  kms_key_id: "KmsKeyId",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

ClientToken is an idempotency token that ensures a call to CreateModel 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 CreateModel. In this case, safely retry your call to CreateModel 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 CreateModel. 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)


194
195
196
197
198
199
200
201
202
203
# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/types.rb', line 194

class CreateModelRequest < Struct.new(
  :project_name,
  :description,
  :client_token,
  :output_config,
  :kms_key_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

A description for the version of the model.

Returns:

  • (String)


194
195
196
197
198
199
200
201
202
203
# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/types.rb', line 194

class CreateModelRequest < Struct.new(
  :project_name,
  :description,
  :client_token,
  :output_config,
  :kms_key_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_idString

The identifier for your AWS Key Management Service (AWS KMS) customer master key (CMK). The key is used to encrypt training and test images copied into the service for model training. Your source images are unaffected. If this parameter is not specified, the copied images are encrypted by a key that AWS owns and manages.

Returns:

  • (String)


194
195
196
197
198
199
200
201
202
203
# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/types.rb', line 194

class CreateModelRequest < Struct.new(
  :project_name,
  :description,
  :client_token,
  :output_config,
  :kms_key_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#output_configTypes::OutputConfig

The location where Amazon Lookout for Vision saves the training results.

Returns:



194
195
196
197
198
199
200
201
202
203
# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/types.rb', line 194

class CreateModelRequest < Struct.new(
  :project_name,
  :description,
  :client_token,
  :output_config,
  :kms_key_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#project_nameString

The name of the project in which you want to create a model version.

Returns:

  • (String)


194
195
196
197
198
199
200
201
202
203
# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/types.rb', line 194

class CreateModelRequest < Struct.new(
  :project_name,
  :description,
  :client_token,
  :output_config,
  :kms_key_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

A set of tags (key-value pairs) that you want to attach to the model.

Returns:



194
195
196
197
198
199
200
201
202
203
# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/types.rb', line 194

class CreateModelRequest < Struct.new(
  :project_name,
  :description,
  :client_token,
  :output_config,
  :kms_key_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end