AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . bedrock ]

get-advanced-prompt-optimization-job

Description

Gets information about an advanced prompt optimization job.

See also: AWS API Documentation

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

  get-advanced-prompt-optimization-job
--job-identifier <value>
[--cli-input-json <value>]
[--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>]
[--v2-debug]

Options

--job-identifier (string)

The ARN or ID of the advanced prompt optimization job.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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

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

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

jobArn -> (string)

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

jobName -> (string)

The name of the advanced prompt optimization job.

jobDescription -> (string)

The description of the advanced prompt optimization job.

jobStatus -> (string)

The status of the advanced prompt optimization job.

inputConfig -> (structure)

The input data configuration for the optimization job.

s3Uri -> (string)

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

outputConfig -> (structure)

The output data configuration for the optimization job.

s3Uri -> (string)

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

encryptionKeyArn -> (string)

The Amazon Resource Name (ARN) of the KMS key used to encrypt the output data.

creationTime -> (timestamp)

The time at which the advanced prompt optimization job was created.

lastModifiedTime -> (timestamp)

The time at which the advanced prompt optimization job was last modified.

failureMessage -> (string)

If the job failed, a message describing the reason for the failure.

modelConfigurations -> (list)

The model configurations used in the optimization job.

(structure)

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

modelId -> (string)

The ID of the model to use for optimization.

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.

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.

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.

stopSequences -> (list)

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

(string)

additionalModelRequestFields -> (map)

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

key -> (string)

value -> (document)