create-model-customization-job¶

Description¶

Creates a fine-tuning job to customize a base model.

You specify the base foundation model and the location of the training data. After the model-customization job completes successfully, your custom model resource will be ready to use. Amazon Bedrock returns validation loss metrics and output generations after the job completes.

For information on the format of training and validation data, see Prepare the datasets .

Model-customization jobs are asynchronous and the completion time depends on the base model and the training/validation data size. To monitor a job, use the GetModelCustomizationJob operation to retrieve the job status.

For more information, see Custom models in the Amazon Bedrock User Guide .

Synopsis¶

  create-model-customization-job
--job-name <value>
--custom-model-name <value>
--role-arn <value>
[--client-request-token <value>]
--base-model-identifier <value>
[--customization-type <value>]
[--custom-model-kms-key-id <value>]
[--job-tags <value>]
[--custom-model-tags <value>]
--training-data-config <value>
[--validation-data-config <value>]
--output-data-config <value>
[--hyper-parameters <value>]
[--vpc-config <value>]
[--customization-config <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options¶

--job-name (string)

A name for the fine-tuning job.

--custom-model-name (string)

A name for the resulting custom model.

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

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

--base-model-identifier (string)

Name of the base model.

--customization-type (string)

The customization type.

Possible values:

FINE_TUNING

CONTINUED_PRE_TRAINING

DISTILLATION

--custom-model-kms-key-id (string)

The custom model is encrypted at rest using this key.

--job-tags (list)

Tags to attach to the job.

(structure)

Definition of the key/value pair for a tag.

key -> (string)

Key for the tag.

value -> (string)

Value for the tag.

Shorthand Syntax:

key=string,value=string ...

JSON Syntax:

[
  {
    "key": "string",
    "value": "string"
  }
  ...
]

--custom-model-tags (list)

Tags to attach to the resulting custom model.

(structure)

Definition of the key/value pair for a tag.

key -> (string)

Key for the tag.

value -> (string)

Value for the tag.

Shorthand Syntax:

key=string,value=string ...

JSON Syntax:

[
  {
    "key": "string",
    "value": "string"
  }
  ...
]

--training-data-config (structure)

Information about the training dataset.

s3Uri -> (string)

The S3 URI where the training data is stored.

invocationLogsConfig -> (structure)

Settings for using invocation logs to customize a model.

usePromptResponse -> (boolean)

Whether to use the model’s response for training, or just the prompt. The default value is False .

invocationLogSource -> (tagged union structure)

The source of the invocation logs.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: s3Uri.

s3Uri -> (string)

The URI of an invocation log in a bucket.

requestMetadataFilters -> (tagged union structure)

Rules for filtering invocation logs based on request metadata.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: equals, notEquals, andAll, orAll.

equals -> (map)

Include results where the key equals the value.

key -> (string)

value -> (string)

notEquals -> (map)

Include results where the key does not equal the value.

key -> (string)

value -> (string)

andAll -> (list)

Include results where all of the based filters match.

(structure)

A mapping of a metadata key to a value that it should or should not equal.

equals -> (map)

Include results where the key equals the value.

key -> (string)

value -> (string)

notEquals -> (map)

Include results where the key does not equal the value.

key -> (string)

value -> (string)

orAll -> (list)

Include results where any of the base filters match.

(structure)

A mapping of a metadata key to a value that it should or should not equal.

equals -> (map)

Include results where the key equals the value.

key -> (string)

value -> (string)

notEquals -> (map)

Include results where the key does not equal the value.

key -> (string)

value -> (string)

JSON Syntax:

{
  "s3Uri": "string",
  "invocationLogsConfig": {
    "usePromptResponse": true|false,
    "invocationLogSource": {
      "s3Uri": "string"
    },
    "requestMetadataFilters": {
      "equals": {"string": "string"
        ...},
      "notEquals": {"string": "string"
        ...},
      "andAll": [
        {
          "equals": {"string": "string"
            ...},
          "notEquals": {"string": "string"
            ...}
        }
        ...
      ],
      "orAll": [
        {
          "equals": {"string": "string"
            ...},
          "notEquals": {"string": "string"
            ...}
        }
        ...
      ]
    }
  }
}

--validation-data-config (structure)

Information about the validation dataset.

validators -> (list)

Information about the validators.

(structure)

Information about a validator.

s3Uri -> (string)

The S3 URI where the validation data is stored.

Shorthand Syntax:

validators=[{s3Uri=string},{s3Uri=string}]

JSON Syntax:

{
  "validators": [
    {
      "s3Uri": "string"
    }
    ...
  ]
}

--output-data-config (structure)

S3 location for the output data.

s3Uri -> (string)

The S3 URI where the output data is stored.

Shorthand Syntax:

s3Uri=string

JSON Syntax:

{
  "s3Uri": "string"
}

--hyper-parameters (map)

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

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--vpc-config (structure)

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 .

subnetIds -> (list)

An array of IDs for each subnet in the VPC to use.

(string)

securityGroupIds -> (list)

An array of IDs for each security group in the VPC to use.

(string)

Shorthand Syntax:

subnetIds=string,string,securityGroupIds=string,string

JSON Syntax:

{
  "subnetIds": ["string", ...],
  "securityGroupIds": ["string", ...]
}

--customization-config (tagged union structure)

The customization configuration for the model customization job.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: distillationConfig.

distillationConfig -> (structure)

The distillation configuration for the custom model.

teacherModelConfig -> (structure)

The teacher model configuration.

teacherModelIdentifier -> (string)

The identifier of the teacher model.

maxResponseLengthForInference -> (integer)

The maximum number of tokens requested when the customization job invokes the teacher model.

Shorthand Syntax:

distillationConfig={teacherModelConfig={teacherModelIdentifier=string,maxResponseLengthForInference=integer}}

JSON Syntax:

{
  "distillationConfig": {
    "teacherModelConfig": {
      "teacherModelIdentifier": "string",
      "maxResponseLengthForInference": integer
    }
  }
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output¶

jobArn -> (string)

Amazon Resource Name (ARN) of the fine tuning job

Table of Contents

Feedback

User Guide

create-model-customization-job¶

Description¶

Synopsis¶

Options¶

Note

Note

Note

Global Options¶

Output¶