aws_sdk_bedrock/client/
create_model_customization_job.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`CreateModelCustomizationJob`](crate::operation::create_model_customization_job::builders::CreateModelCustomizationJobFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`job_name(impl Into<String>)`](crate::operation::create_model_customization_job::builders::CreateModelCustomizationJobFluentBuilder::job_name) / [`set_job_name(Option<String>)`](crate::operation::create_model_customization_job::builders::CreateModelCustomizationJobFluentBuilder::set_job_name):<br>required: **true**<br><p>A name for the fine-tuning job.</p><br>
7    ///   - [`custom_model_name(impl Into<String>)`](crate::operation::create_model_customization_job::builders::CreateModelCustomizationJobFluentBuilder::custom_model_name) / [`set_custom_model_name(Option<String>)`](crate::operation::create_model_customization_job::builders::CreateModelCustomizationJobFluentBuilder::set_custom_model_name):<br>required: **true**<br><p>A name for the resulting custom model.</p><br>
8    ///   - [`role_arn(impl Into<String>)`](crate::operation::create_model_customization_job::builders::CreateModelCustomizationJobFluentBuilder::role_arn) / [`set_role_arn(Option<String>)`](crate::operation::create_model_customization_job::builders::CreateModelCustomizationJobFluentBuilder::set_role_arn):<br>required: **true**<br><p>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 <code>iam:PassRole</code> permission.</p><br>
9    ///   - [`client_request_token(impl Into<String>)`](crate::operation::create_model_customization_job::builders::CreateModelCustomizationJobFluentBuilder::client_request_token) / [`set_client_request_token(Option<String>)`](crate::operation::create_model_customization_job::builders::CreateModelCustomizationJobFluentBuilder::set_client_request_token):<br>required: **false**<br><p>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 <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p><br>
10    ///   - [`base_model_identifier(impl Into<String>)`](crate::operation::create_model_customization_job::builders::CreateModelCustomizationJobFluentBuilder::base_model_identifier) / [`set_base_model_identifier(Option<String>)`](crate::operation::create_model_customization_job::builders::CreateModelCustomizationJobFluentBuilder::set_base_model_identifier):<br>required: **true**<br><p>Name of the base model.</p><br>
11    ///   - [`customization_type(CustomizationType)`](crate::operation::create_model_customization_job::builders::CreateModelCustomizationJobFluentBuilder::customization_type) / [`set_customization_type(Option<CustomizationType>)`](crate::operation::create_model_customization_job::builders::CreateModelCustomizationJobFluentBuilder::set_customization_type):<br>required: **false**<br><p>The customization type.</p><br>
12    ///   - [`custom_model_kms_key_id(impl Into<String>)`](crate::operation::create_model_customization_job::builders::CreateModelCustomizationJobFluentBuilder::custom_model_kms_key_id) / [`set_custom_model_kms_key_id(Option<String>)`](crate::operation::create_model_customization_job::builders::CreateModelCustomizationJobFluentBuilder::set_custom_model_kms_key_id):<br>required: **false**<br><p>The custom model is encrypted at rest using this key.</p><br>
13    ///   - [`job_tags(Tag)`](crate::operation::create_model_customization_job::builders::CreateModelCustomizationJobFluentBuilder::job_tags) / [`set_job_tags(Option<Vec::<Tag>>)`](crate::operation::create_model_customization_job::builders::CreateModelCustomizationJobFluentBuilder::set_job_tags):<br>required: **false**<br><p>Tags to attach to the job.</p><br>
14    ///   - [`custom_model_tags(Tag)`](crate::operation::create_model_customization_job::builders::CreateModelCustomizationJobFluentBuilder::custom_model_tags) / [`set_custom_model_tags(Option<Vec::<Tag>>)`](crate::operation::create_model_customization_job::builders::CreateModelCustomizationJobFluentBuilder::set_custom_model_tags):<br>required: **false**<br><p>Tags to attach to the resulting custom model.</p><br>
15    ///   - [`training_data_config(TrainingDataConfig)`](crate::operation::create_model_customization_job::builders::CreateModelCustomizationJobFluentBuilder::training_data_config) / [`set_training_data_config(Option<TrainingDataConfig>)`](crate::operation::create_model_customization_job::builders::CreateModelCustomizationJobFluentBuilder::set_training_data_config):<br>required: **true**<br><p>Information about the training dataset.</p><br>
16    ///   - [`validation_data_config(ValidationDataConfig)`](crate::operation::create_model_customization_job::builders::CreateModelCustomizationJobFluentBuilder::validation_data_config) / [`set_validation_data_config(Option<ValidationDataConfig>)`](crate::operation::create_model_customization_job::builders::CreateModelCustomizationJobFluentBuilder::set_validation_data_config):<br>required: **false**<br><p>Information about the validation dataset.</p><br>
17    ///   - [`output_data_config(OutputDataConfig)`](crate::operation::create_model_customization_job::builders::CreateModelCustomizationJobFluentBuilder::output_data_config) / [`set_output_data_config(Option<OutputDataConfig>)`](crate::operation::create_model_customization_job::builders::CreateModelCustomizationJobFluentBuilder::set_output_data_config):<br>required: **true**<br><p>S3 location for the output data.</p><br>
18    ///   - [`hyper_parameters(impl Into<String>, impl Into<String>)`](crate::operation::create_model_customization_job::builders::CreateModelCustomizationJobFluentBuilder::hyper_parameters) / [`set_hyper_parameters(Option<HashMap::<String, String>>)`](crate::operation::create_model_customization_job::builders::CreateModelCustomizationJobFluentBuilder::set_hyper_parameters):<br>required: **false**<br><p>Parameters related to tuning the model. For details on the format for different models, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models-hp.html">Custom model hyperparameters</a>.</p><br>
19    ///   - [`vpc_config(VpcConfig)`](crate::operation::create_model_customization_job::builders::CreateModelCustomizationJobFluentBuilder::vpc_config) / [`set_vpc_config(Option<VpcConfig>)`](crate::operation::create_model_customization_job::builders::CreateModelCustomizationJobFluentBuilder::set_vpc_config):<br>required: **false**<br><p>The configuration of the Virtual Private Cloud (VPC) that contains the resources that you're using for this job. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/vpc-model-customization.html">Protect your model customization jobs using a VPC</a>.</p><br>
20    ///   - [`customization_config(CustomizationConfig)`](crate::operation::create_model_customization_job::builders::CreateModelCustomizationJobFluentBuilder::customization_config) / [`set_customization_config(Option<CustomizationConfig>)`](crate::operation::create_model_customization_job::builders::CreateModelCustomizationJobFluentBuilder::set_customization_config):<br>required: **false**<br><p>The customization configuration for the model customization job.</p><br>
21    /// - On success, responds with [`CreateModelCustomizationJobOutput`](crate::operation::create_model_customization_job::CreateModelCustomizationJobOutput) with field(s):
22    ///   - [`job_arn(String)`](crate::operation::create_model_customization_job::CreateModelCustomizationJobOutput::job_arn): <p>Amazon Resource Name (ARN) of the fine tuning job</p>
23    /// - On failure, responds with [`SdkError<CreateModelCustomizationJobError>`](crate::operation::create_model_customization_job::CreateModelCustomizationJobError)
24    pub fn create_model_customization_job(
25        &self,
26    ) -> crate::operation::create_model_customization_job::builders::CreateModelCustomizationJobFluentBuilder {
27        crate::operation::create_model_customization_job::builders::CreateModelCustomizationJobFluentBuilder::new(self.handle.clone())
28    }
29}