Class: Aws::Bedrock::Types::CreateModelCustomizationJobRequest

Inherits:

Struct

Object
Struct
Aws::Bedrock::Types::CreateModelCustomizationJobRequest

show all

Includes:: Structure

Defined in:: lib/aws-sdk-bedrock/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#base_model_identifier ⇒ String

Name of the base model.
#client_request_token ⇒ String

A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
#custom_model_kms_key_id ⇒ String

The custom model is encrypted at rest using this key.
#custom_model_name ⇒ String

A name for the resulting custom model.
#custom_model_tags ⇒ Array<Types::Tag>

Tags to attach to the resulting custom model.
#customization_config ⇒ Types::CustomizationConfig

The customization configuration for the model customization job.
#customization_type ⇒ String

The customization type.
#hyper_parameters ⇒ Hash<String,String>

Parameters related to tuning the model.
#job_name ⇒ String

A name for the fine-tuning job.
#job_tags ⇒ Array<Types::Tag>

Tags to attach to the job.
#output_data_config ⇒ Types::OutputDataConfig

S3 location for the output data.
#role_arn ⇒ String

The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can assume to perform tasks on your behalf.
#training_data_config ⇒ Types::TrainingDataConfig

Information about the training dataset.
#validation_data_config ⇒ Types::ValidationDataConfig

Information about the validation dataset.
#vpc_config ⇒ Types::VpcConfig

The configuration of the Virtual Private Cloud (VPC) that contains the resources that you’re using for this job.

Instance Attribute Details

#base_model_identifier ⇒ `String`

Name of the base model.

Returns:

(String)

# File 'lib/aws-sdk-bedrock/types.rb', line 4067

class CreateModelCustomizationJobRequest < Struct.new(
  :job_name,
  :custom_model_name,
  :role_arn,
  :client_request_token,
  :base_model_identifier,
  :customization_type,
  :custom_model_kms_key_id,
  :job_tags,
  :custom_model_tags,
  :training_data_config,
  :validation_data_config,
  :output_data_config,
  :hyper_parameters,
  :vpc_config,
  :customization_config)
  SENSITIVE = []
  include Aws::Structure
end

#client_request_token ⇒ `String`

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see [Ensuring idempotency].

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

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html

Returns:

(String)

# File 'lib/aws-sdk-bedrock/types.rb', line 4067

class CreateModelCustomizationJobRequest < Struct.new(
  :job_name,
  :custom_model_name,
  :role_arn,
  :client_request_token,
  :base_model_identifier,
  :customization_type,
  :custom_model_kms_key_id,
  :job_tags,
  :custom_model_tags,
  :training_data_config,
  :validation_data_config,
  :output_data_config,
  :hyper_parameters,
  :vpc_config,
  :customization_config)
  SENSITIVE = []
  include Aws::Structure
end

#custom_model_kms_key_id ⇒ `String`

The custom model is encrypted at rest using this key.

Returns:

(String)

# File 'lib/aws-sdk-bedrock/types.rb', line 4067

class CreateModelCustomizationJobRequest < Struct.new(
  :job_name,
  :custom_model_name,
  :role_arn,
  :client_request_token,
  :base_model_identifier,
  :customization_type,
  :custom_model_kms_key_id,
  :job_tags,
  :custom_model_tags,
  :training_data_config,
  :validation_data_config,
  :output_data_config,
  :hyper_parameters,
  :vpc_config,
  :customization_config)
  SENSITIVE = []
  include Aws::Structure
end

#custom_model_name ⇒ `String`

A name for the resulting custom model.

Returns:

(String)

# File 'lib/aws-sdk-bedrock/types.rb', line 4067

class CreateModelCustomizationJobRequest < Struct.new(
  :job_name,
  :custom_model_name,
  :role_arn,
  :client_request_token,
  :base_model_identifier,
  :customization_type,
  :custom_model_kms_key_id,
  :job_tags,
  :custom_model_tags,
  :training_data_config,
  :validation_data_config,
  :output_data_config,
  :hyper_parameters,
  :vpc_config,
  :customization_config)
  SENSITIVE = []
  include Aws::Structure
end

#custom_model_tags ⇒ `Array<Types::Tag>`

Tags to attach to the resulting custom model.

Returns:

(Array<Types::Tag>)

# File 'lib/aws-sdk-bedrock/types.rb', line 4067

class CreateModelCustomizationJobRequest < Struct.new(
  :job_name,
  :custom_model_name,
  :role_arn,
  :client_request_token,
  :base_model_identifier,
  :customization_type,
  :custom_model_kms_key_id,
  :job_tags,
  :custom_model_tags,
  :training_data_config,
  :validation_data_config,
  :output_data_config,
  :hyper_parameters,
  :vpc_config,
  :customization_config)
  SENSITIVE = []
  include Aws::Structure
end

#customization_config ⇒ `Types::CustomizationConfig`

The customization configuration for the model customization job.

Returns:

(Types::CustomizationConfig)

# File 'lib/aws-sdk-bedrock/types.rb', line 4067

class CreateModelCustomizationJobRequest < Struct.new(
  :job_name,
  :custom_model_name,
  :role_arn,
  :client_request_token,
  :base_model_identifier,
  :customization_type,
  :custom_model_kms_key_id,
  :job_tags,
  :custom_model_tags,
  :training_data_config,
  :validation_data_config,
  :output_data_config,
  :hyper_parameters,
  :vpc_config,
  :customization_config)
  SENSITIVE = []
  include Aws::Structure
end

#customization_type ⇒ `String`

The customization type.

Returns:

(String)

# File 'lib/aws-sdk-bedrock/types.rb', line 4067

class CreateModelCustomizationJobRequest < Struct.new(
  :job_name,
  :custom_model_name,
  :role_arn,
  :client_request_token,
  :base_model_identifier,
  :customization_type,
  :custom_model_kms_key_id,
  :job_tags,
  :custom_model_tags,
  :training_data_config,
  :validation_data_config,
  :output_data_config,
  :hyper_parameters,
  :vpc_config,
  :customization_config)
  SENSITIVE = []
  include Aws::Structure
end

#hyper_parameters ⇒ `Hash<String,String>`

Parameters related to tuning the model. For details on the format for different models, see [Custom model hyperparameters].

[1]: docs.aws.amazon.com/bedrock/latest/userguide/custom-models-hp.html

Returns:

(Hash<String,String>)

# File 'lib/aws-sdk-bedrock/types.rb', line 4067

class CreateModelCustomizationJobRequest < Struct.new(
  :job_name,
  :custom_model_name,
  :role_arn,
  :client_request_token,
  :base_model_identifier,
  :customization_type,
  :custom_model_kms_key_id,
  :job_tags,
  :custom_model_tags,
  :training_data_config,
  :validation_data_config,
  :output_data_config,
  :hyper_parameters,
  :vpc_config,
  :customization_config)
  SENSITIVE = []
  include Aws::Structure
end

#job_name ⇒ `String`

A name for the fine-tuning job.

Returns:

(String)

# File 'lib/aws-sdk-bedrock/types.rb', line 4067

class CreateModelCustomizationJobRequest < Struct.new(
  :job_name,
  :custom_model_name,
  :role_arn,
  :client_request_token,
  :base_model_identifier,
  :customization_type,
  :custom_model_kms_key_id,
  :job_tags,
  :custom_model_tags,
  :training_data_config,
  :validation_data_config,
  :output_data_config,
  :hyper_parameters,
  :vpc_config,
  :customization_config)
  SENSITIVE = []
  include Aws::Structure
end

#job_tags ⇒ `Array<Types::Tag>`

Tags to attach to the job.

Returns:

(Array<Types::Tag>)

# File 'lib/aws-sdk-bedrock/types.rb', line 4067

class CreateModelCustomizationJobRequest < Struct.new(
  :job_name,
  :custom_model_name,
  :role_arn,
  :client_request_token,
  :base_model_identifier,
  :customization_type,
  :custom_model_kms_key_id,
  :job_tags,
  :custom_model_tags,
  :training_data_config,
  :validation_data_config,
  :output_data_config,
  :hyper_parameters,
  :vpc_config,
  :customization_config)
  SENSITIVE = []
  include Aws::Structure
end

#output_data_config ⇒ `Types::OutputDataConfig`

S3 location for the output data.

Returns:

(Types::OutputDataConfig)

# File 'lib/aws-sdk-bedrock/types.rb', line 4067

class CreateModelCustomizationJobRequest < Struct.new(
  :job_name,
  :custom_model_name,
  :role_arn,
  :client_request_token,
  :base_model_identifier,
  :customization_type,
  :custom_model_kms_key_id,
  :job_tags,
  :custom_model_tags,
  :training_data_config,
  :validation_data_config,
  :output_data_config,
  :hyper_parameters,
  :vpc_config,
  :customization_config)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ `String`

The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can assume to perform tasks on your behalf. For example, during model training, Amazon Bedrock needs your permission to read input data from an S3 bucket, write model artifacts to an S3 bucket. To pass this role to Amazon Bedrock, the caller of this API must have the ‘iam:PassRole` permission.

Returns:

(String)

# File 'lib/aws-sdk-bedrock/types.rb', line 4067

class CreateModelCustomizationJobRequest < Struct.new(
  :job_name,
  :custom_model_name,
  :role_arn,
  :client_request_token,
  :base_model_identifier,
  :customization_type,
  :custom_model_kms_key_id,
  :job_tags,
  :custom_model_tags,
  :training_data_config,
  :validation_data_config,
  :output_data_config,
  :hyper_parameters,
  :vpc_config,
  :customization_config)
  SENSITIVE = []
  include Aws::Structure
end

#training_data_config ⇒ `Types::TrainingDataConfig`

Information about the training dataset.

Returns:

(Types::TrainingDataConfig)

# File 'lib/aws-sdk-bedrock/types.rb', line 4067

class CreateModelCustomizationJobRequest < Struct.new(
  :job_name,
  :custom_model_name,
  :role_arn,
  :client_request_token,
  :base_model_identifier,
  :customization_type,
  :custom_model_kms_key_id,
  :job_tags,
  :custom_model_tags,
  :training_data_config,
  :validation_data_config,
  :output_data_config,
  :hyper_parameters,
  :vpc_config,
  :customization_config)
  SENSITIVE = []
  include Aws::Structure
end

#validation_data_config ⇒ `Types::ValidationDataConfig`

Information about the validation dataset.

Returns:

(Types::ValidationDataConfig)

# File 'lib/aws-sdk-bedrock/types.rb', line 4067

class CreateModelCustomizationJobRequest < Struct.new(
  :job_name,
  :custom_model_name,
  :role_arn,
  :client_request_token,
  :base_model_identifier,
  :customization_type,
  :custom_model_kms_key_id,
  :job_tags,
  :custom_model_tags,
  :training_data_config,
  :validation_data_config,
  :output_data_config,
  :hyper_parameters,
  :vpc_config,
  :customization_config)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_config ⇒ `Types::VpcConfig`

The configuration of the Virtual Private Cloud (VPC) that contains the resources that you’re using for this job. For more information, see [Protect your model customization jobs using a VPC].

[1]: docs.aws.amazon.com/bedrock/latest/userguide/vpc-model-customization.html

Returns:

(Types::VpcConfig)

# File 'lib/aws-sdk-bedrock/types.rb', line 4067

class CreateModelCustomizationJobRequest < Struct.new(
  :job_name,
  :custom_model_name,
  :role_arn,
  :client_request_token,
  :base_model_identifier,
  :customization_type,
  :custom_model_kms_key_id,
  :job_tags,
  :custom_model_tags,
  :training_data_config,
  :validation_data_config,
  :output_data_config,
  :hyper_parameters,
  :vpc_config,
  :customization_config)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::Bedrock::Types::CreateModelCustomizationJobRequest

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#base_model_identifier ⇒ String

#client_request_token ⇒ String

#custom_model_kms_key_id ⇒ String

#custom_model_name ⇒ String

#custom_model_tags ⇒ Array<Types::Tag>

#customization_config ⇒ Types::CustomizationConfig

#customization_type ⇒ String

#hyper_parameters ⇒ Hash<String,String>

#job_name ⇒ String

#job_tags ⇒ Array<Types::Tag>

#output_data_config ⇒ Types::OutputDataConfig

#role_arn ⇒ String

#training_data_config ⇒ Types::TrainingDataConfig

#validation_data_config ⇒ Types::ValidationDataConfig

#vpc_config ⇒ Types::VpcConfig

#base_model_identifier ⇒ `String`

#client_request_token ⇒ `String`

#custom_model_kms_key_id ⇒ `String`

#custom_model_name ⇒ `String`

#custom_model_tags ⇒ `Array<Types::Tag>`

#customization_config ⇒ `Types::CustomizationConfig`

#customization_type ⇒ `String`

#hyper_parameters ⇒ `Hash<String,String>`

#job_name ⇒ `String`

#job_tags ⇒ `Array<Types::Tag>`

#output_data_config ⇒ `Types::OutputDataConfig`

#role_arn ⇒ `String`

#training_data_config ⇒ `Types::TrainingDataConfig`

#validation_data_config ⇒ `Types::ValidationDataConfig`

#vpc_config ⇒ `Types::VpcConfig`