Package software.amazon.awssdk.services.bedrock.model

Class CreateModelCustomizationJobRequest

    • Method Detail

      • jobName

        public final String jobName()

        A name for the fine-tuning job.

        Returns:
        A name for the fine-tuning job.

      • customModelName

        public final String customModelName()

        A name for the resulting custom model.

        Returns:
        A name for the resulting custom model.

      • roleArn

        public final String roleArn()

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

      • clientRequestToken

        public final String clientRequestToken()

        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.

        Returns:
        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.

      • baseModelIdentifier

        public final String baseModelIdentifier()

        Name of the base model.

        Returns:
        Name of the base model.

      • customModelKmsKeyId

        public final String customModelKmsKeyId()

        The custom model is encrypted at rest using this key.

        Returns:
        The custom model is encrypted at rest using this key.

      • hasJobTags

        public final boolean hasJobTags()
        For responses, this returns true if the service returned a value for the JobTags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • jobTags

        public final List<Tag> jobTags()

        Tags to attach to the job.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasJobTags() method.

        Returns:
        Tags to attach to the job.

      • hasCustomModelTags

        public final boolean hasCustomModelTags()
        For responses, this returns true if the service returned a value for the CustomModelTags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • customModelTags

        public final List<Tag> customModelTags()

        Tags to attach to the resulting custom model.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCustomModelTags() method.

        Returns:
        Tags to attach to the resulting custom model.

      • trainingDataConfig

        public final TrainingDataConfig trainingDataConfig()

        Information about the training dataset.

        Returns:
        Information about the training dataset.

      • validationDataConfig

        public final ValidationDataConfig validationDataConfig()

        Information about the validation dataset.

        Returns:
        Information about the validation dataset.

      • outputDataConfig

        public final OutputDataConfig outputDataConfig()

        S3 location for the output data.

        Returns:
        S3 location for the output data.

      • hasHyperParameters

        public final boolean hasHyperParameters()
        For responses, this returns true if the service returned a value for the HyperParameters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • hyperParameters

        public final Map<String,​String> hyperParameters()

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

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasHyperParameters() method.

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

      • vpcConfig

        public final VpcConfig vpcConfig()

        VPC configuration (optional). Configuration parameters for the private Virtual Private Cloud (VPC) that contains the resources you are using for this job.

        Returns:
        VPC configuration (optional). Configuration parameters for the private Virtual Private Cloud (VPC) that contains the resources you are using for this job.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object