AWS CLI Command Reference

[ aws . bedrock ]

create-advanced-prompt-optimization-job

Description

Creates an advanced prompt optimization job. The job optimizes your prompt templates for specific models using your evaluation dataset and criteria.

See also: AWS API Documentation

create-advanced-prompt-optimization-job uses document type values. Document types follow the JSON data model where valid values are: strings, numbers, booleans, null, arrays, and objects. For command input, options and nested parameters that are labeled with the type document must be provided as JSON. Shorthand syntax does not support document types.

Synopsis

  create-advanced-prompt-optimization-job
--job-name <value>
[--job-description <value>]
[--client-token <value>]
--input-config <value>
--output-config <value>
[--encryption-key-arn <value>]
[--tags <value>]
--model-configurations <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]
[--cli-error-format <value>]

Options

--job-name (string) [required]

A name for the advanced prompt optimization job.

Constraints:

  • min: 1
  • max: 100
  • pattern: [a-zA-Z0-9][a-zA-Z0-9.+-]*

--job-description (string)

A description of the advanced prompt optimization job.

Constraints:

  • min: 1
  • max: 500

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

Constraints:

  • min: 1
  • max: 256
  • pattern: [a-zA-Z0-9]([-a-zA-Z0-9]{0,254}[a-zA-Z0-9])?

--input-config (structure) [required]

Specifies the S3 location of your JSONL input file containing prompt templates and evaluation samples.

s3Uri -> (string) [required]

The S3 URI of the JSONL input file containing prompt templates and evaluation samples.

Constraints:

  • min: 1
  • max: 1024
  • pattern: s3://[a-z0-9][-.a-z0-9]{1,61}[a-z0-9](?:/[-!_*'().a-z0-9A-Z]+(?:/[-!_*'().a-z0-9A-Z]+)*)?/?

Shorthand Syntax:

s3Uri=string

JSON Syntax:

{
  "s3Uri": "string"
}

--output-config (structure) [required]

Specifies the S3 location where optimization results will be stored.

s3Uri -> (string) [required]

The S3 URI prefix where the optimization results will be written.

Constraints:

  • min: 1
  • max: 1024
  • pattern: s3://[a-z0-9][-.a-z0-9]{1,61}[a-z0-9](?:/[-!_*'().a-z0-9A-Z]+(?:/[-!_*'().a-z0-9A-Z]+)*)?/

Shorthand Syntax:

s3Uri=string

JSON Syntax:

{
  "s3Uri": "string"
}

--encryption-key-arn (string)

The Amazon Resource Name (ARN) of the KMS key used for encrypting the output data. If not specified, the output is encrypted with an Amazon-owned KMS key.

Constraints:

  • min: 1
  • max: 2048
  • pattern: arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}

--tags (list)

Tags to associate with the advanced prompt optimization job.

Constraints:

  • min: 0
  • max: 200

(structure)

Definition of the key/value pair for a tag.

key -> (string) [required]

Key for the tag.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9\s._:/=+@-]*

value -> (string) [required]

Value for the tag.

Constraints:

  • min: 0
  • max: 256
  • pattern: [a-zA-Z0-9\s._:/=+@-]*

Shorthand Syntax:

key=string,value=string ...

JSON Syntax:

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

--model-configurations (list) [required]

A list of model configurations specifying the target models for prompt optimization. You can specify up to 5 models.

Constraints:

  • min: 1
  • max: 5

(structure)

Contains the configuration for a model used in an advanced prompt optimization job, including the model ID and inference parameters.

modelId -> (string) [required]

The ID of the model to use for optimization.

Constraints:

  • min: 0
  • max: 140
  • pattern: [a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}(/[a-z0-9]{12}|)

inferenceConfig -> (structure)

The inference configuration for the model, including parameters such as maximum tokens, temperature, and top-p.

maxTokens -> (integer)

The maximum number of tokens to allow in the generated response. The default value is the maximum allowed value for the model that you are using.

Constraints:

  • min: 1

temperature -> (float)

The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.

Constraints:

  • min: 0
  • max: 1

topP -> (float)

The percentage of most-likely candidates that the model considers for the next token. For example, if you choose a value of 0.8 for topP , the model selects from the top 80% of the probability distribution of tokens that could be next in the sequence.

Constraints:

  • min: 0
  • max: 1

stopSequences -> (list)

A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.

Constraints:

  • min: 0
  • max: 2500

(string)

Constraints:

  • min: 1

additionalModelRequestFields -> (map)

Additional model request fields. Use this to pass model-specific parameters that are not included in the standard inference configuration.

key -> (string)

Constraints:

  • min: 1
  • max: 100

value -> (document)

Shorthand Syntax:

modelId=string,inferenceConfig={maxTokens=integer,temperature=float,topP=float,stopSequences=[string,string]} ...

JSON Syntax:

[
  {
    "modelId": "string",
    "inferenceConfig": {
      "maxTokens": integer,
      "temperature": float,
      "topP": float,
      "stopSequences": ["string", ...]
    },
    "additionalModelRequestFields": {"string": {...}
      ...}
  }
  ...
]

--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
  • off

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

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

Output

jobArn -> (string)

The Amazon Resource Name (ARN) of the created advanced prompt optimization job.

Constraints:

  • min: 0
  • max: 1011
  • pattern: arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:advanced-prompt-optimization-job/[a-z0-9]{12}
© Copyright 2026, Amazon Web Services. Created using Sphinx.