update-prompt¶

Description¶

Modifies a prompt in your prompt library. Include both fields that you want to keep and fields that you want to replace. For more information, see Prompt management in Amazon Bedrock and Edit prompts in your prompt library in the Amazon Bedrock User Guide.

Synopsis¶

  update-prompt
--name <value>
[--description <value>]
[--customer-encryption-key-arn <value>]
[--default-variant <value>]
[--variants <value>]
--prompt-identifier <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¶

--name (string)

A name for the prompt.

--description (string)

A description for the prompt.

--customer-encryption-key-arn (string)

The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.

--default-variant (string)

The name of the default variant for the prompt. This value must match the name field in the relevant PromptVariant object.

--variants (list)

A list of objects, each containing details about a variant of the prompt.

(structure)

Contains details about a variant of the prompt.

name -> (string)

The name of the prompt variant.

templateType -> (string)

The type of prompt template to use.

templateConfiguration -> (tagged union structure)

Contains configurations for the prompt template.

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

text -> (structure)

Contains configurations for the text in a message for a prompt.

text -> (string)

The message for the prompt.

cachePoint -> (structure)

A cache checkpoint within a template configuration.

type -> (string)

Indicates that the CachePointBlock is of the default type

inputVariables -> (list)

An array of the variables in the prompt template.

(structure)

Contains information about a variable in the prompt.

name -> (string)

The name of the variable.

chat -> (structure)

Contains configurations to use the prompt in a conversational format.

messages -> (list)

Contains messages in the chat for the prompt.

(structure)

A message input or response from a model. For more information, see Create a prompt using Prompt management .

role -> (string)

The role that the message belongs to.

content -> (list)

The content in the message.

(tagged union structure)

Contains the content for the message you pass to, or receive from a model. For more information, see Create a prompt using Prompt management .

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

text -> (string)

The text in the message.

cachePoint -> (structure)

Creates a cache checkpoint within a message.

type -> (string)

Indicates that the CachePointBlock is of the default type

system -> (list)

Contains system prompts to provide context to the model or to describe how it should behave.

(tagged union structure)

Contains a system prompt to provide context to the model or to describe how it should behave. For more information, see Create a prompt using Prompt management .

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

text -> (string)

The text in the system prompt.

cachePoint -> (structure)

Creates a cache checkpoint within a tool designation

type -> (string)

Indicates that the CachePointBlock is of the default type

inputVariables -> (list)

An array of the variables in the prompt template.

(structure)

Contains information about a variable in the prompt.

name -> (string)

The name of the variable.

toolConfiguration -> (structure)

Configuration information for the tools that the model can use when generating a response.

tools -> (list)

An array of tools to pass to a model.

(tagged union structure)

Contains configurations for a tool that a model can use when generating a response. For more information, see Use a tool to complete an Amazon Bedrock model response .

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

toolSpec -> (structure)

The specification for the tool.

name -> (string)

The name of the tool.

description -> (string)

The description of the tool.

inputSchema -> (tagged union structure)

The input schema for the tool.

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

json -> (document)

A JSON object defining the input schema for the tool.

cachePoint -> (structure)

Creates a cache checkpoint within a tool designation

type -> (string)

Indicates that the CachePointBlock is of the default type

toolChoice -> (tagged union structure)

Defines which tools the model should request when invoked.

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

auto -> (structure)

Defines tools. The model automatically decides whether to call a tool or to generate text instead.

any -> (structure)

Defines tools, at least one of which must be requested by the model. No text is generated but the results of tool use are sent back to the model to help generate a response.

tool -> (structure)

Defines a specific tool that the model must request. No text is generated but the results of tool use are sent back to the model to help generate a response.

name -> (string)

The name of the tool.

modelId -> (string)

The unique identifier of the model or inference profile with which to run inference on the prompt.

inferenceConfiguration -> (tagged union structure)

Contains inference configurations for the prompt variant.

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

text -> (structure)

Contains inference configurations for a text prompt.

temperature -> (float)

Controls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs.

topP -> (float)

The percentage of most-likely candidates that the model considers for the next token.

maxTokens -> (integer)

The maximum number of tokens to return in the response.

stopSequences -> (list)

A list of strings that define sequences after which the model will stop generating.

(string)

metadata -> (list)

An array of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant.

(structure)

Contains a key-value pair that defines a metadata tag and value to attach to a prompt variant. For more information, see Create a prompt using Prompt management .

key -> (string)

The key of a metadata tag for a prompt variant.

value -> (string)

The value of a metadata tag for a prompt variant.

additionalModelRequestFields -> (document)

Contains model-specific inference configurations that aren’t in the inferenceConfiguration field. To see model-specific inference parameters, see Inference request parameters and response fields for foundation models .

genAiResource -> (tagged union structure)

Specifies a generative AI resource with which to use the prompt.

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

agent -> (structure)

Specifies an Amazon Bedrock agent with which to use the prompt.

agentIdentifier -> (string)

The ARN of the agent with which to use the prompt.

JSON Syntax:

[
  {
    "name": "string",
    "templateType": "TEXT"|"CHAT",
    "templateConfiguration": {
      "text": {
        "text": "string",
        "cachePoint": {
          "type": "default"
        },
        "inputVariables": [
          {
            "name": "string"
          }
          ...
        ]
      },
      "chat": {
        "messages": [
          {
            "role": "user"|"assistant",
            "content": [
              {
                "text": "string",
                "cachePoint": {
                  "type": "default"
                }
              }
              ...
            ]
          }
          ...
        ],
        "system": [
          {
            "text": "string",
            "cachePoint": {
              "type": "default"
            }
          }
          ...
        ],
        "inputVariables": [
          {
            "name": "string"
          }
          ...
        ],
        "toolConfiguration": {
          "tools": [
            {
              "toolSpec": {
                "name": "string",
                "description": "string",
                "inputSchema": {
                  "json": {...}
                }
              },
              "cachePoint": {
                "type": "default"
              }
            }
            ...
          ],
          "toolChoice": {
            "auto": {

            },
            "any": {

            },
            "tool": {
              "name": "string"
            }
          }
        }
      }
    },
    "modelId": "string",
    "inferenceConfiguration": {
      "text": {
        "temperature": float,
        "topP": float,
        "maxTokens": integer,
        "stopSequences": ["string", ...]
      }
    },
    "metadata": [
      {
        "key": "string",
        "value": "string"
      }
      ...
    ],
    "additionalModelRequestFields": {...},
    "genAiResource": {
      "agent": {
        "agentIdentifier": "string"
      }
    }
  }
  ...
]

--prompt-identifier (string)

The unique identifier of the prompt.

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

name -> (string)

The name of the prompt.

description -> (string)

The description of the prompt.

customerEncryptionKeyArn -> (string)

The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.

defaultVariant -> (string)

The name of the default variant for the prompt. This value must match the name field in the relevant PromptVariant object.

variants -> (list)

A list of objects, each containing details about a variant of the prompt.

(structure)

Contains details about a variant of the prompt.

name -> (string)

The name of the prompt variant.

templateType -> (string)

The type of prompt template to use.

templateConfiguration -> (tagged union structure)

Contains configurations for the prompt template.

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

text -> (structure)

Contains configurations for the text in a message for a prompt.

text -> (string)

The message for the prompt.

cachePoint -> (structure)

A cache checkpoint within a template configuration.

type -> (string)

Indicates that the CachePointBlock is of the default type

inputVariables -> (list)

An array of the variables in the prompt template.

(structure)

Contains information about a variable in the prompt.

name -> (string)

The name of the variable.

chat -> (structure)

Contains configurations to use the prompt in a conversational format.

messages -> (list)

Contains messages in the chat for the prompt.

(structure)

A message input or response from a model. For more information, see Create a prompt using Prompt management .

role -> (string)

The role that the message belongs to.

content -> (list)

The content in the message.

(tagged union structure)

Contains the content for the message you pass to, or receive from a model. For more information, see Create a prompt using Prompt management .

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

text -> (string)

The text in the message.

cachePoint -> (structure)

Creates a cache checkpoint within a message.

type -> (string)

Indicates that the CachePointBlock is of the default type

system -> (list)

Contains system prompts to provide context to the model or to describe how it should behave.

(tagged union structure)

Contains a system prompt to provide context to the model or to describe how it should behave. For more information, see Create a prompt using Prompt management .

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

text -> (string)

The text in the system prompt.

cachePoint -> (structure)

Creates a cache checkpoint within a tool designation

type -> (string)

Indicates that the CachePointBlock is of the default type

inputVariables -> (list)

An array of the variables in the prompt template.

(structure)

Contains information about a variable in the prompt.

name -> (string)

The name of the variable.

toolConfiguration -> (structure)

Configuration information for the tools that the model can use when generating a response.

tools -> (list)

An array of tools to pass to a model.

(tagged union structure)

Contains configurations for a tool that a model can use when generating a response. For more information, see Use a tool to complete an Amazon Bedrock model response .

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

toolSpec -> (structure)

The specification for the tool.

name -> (string)

The name of the tool.

description -> (string)

The description of the tool.

inputSchema -> (tagged union structure)

The input schema for the tool.

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

json -> (document)

A JSON object defining the input schema for the tool.

cachePoint -> (structure)

Creates a cache checkpoint within a tool designation

type -> (string)

Indicates that the CachePointBlock is of the default type

toolChoice -> (tagged union structure)

Defines which tools the model should request when invoked.

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

auto -> (structure)

Defines tools. The model automatically decides whether to call a tool or to generate text instead.

any -> (structure)

Defines tools, at least one of which must be requested by the model. No text is generated but the results of tool use are sent back to the model to help generate a response.

tool -> (structure)

Defines a specific tool that the model must request. No text is generated but the results of tool use are sent back to the model to help generate a response.

name -> (string)

The name of the tool.

modelId -> (string)

The unique identifier of the model or inference profile with which to run inference on the prompt.

inferenceConfiguration -> (tagged union structure)

Contains inference configurations for the prompt variant.

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

text -> (structure)

Contains inference configurations for a text prompt.

temperature -> (float)

Controls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs.

topP -> (float)

The percentage of most-likely candidates that the model considers for the next token.

maxTokens -> (integer)

The maximum number of tokens to return in the response.

stopSequences -> (list)

A list of strings that define sequences after which the model will stop generating.

(string)

metadata -> (list)

An array of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant.

(structure)

Contains a key-value pair that defines a metadata tag and value to attach to a prompt variant. For more information, see Create a prompt using Prompt management .

key -> (string)

The key of a metadata tag for a prompt variant.

value -> (string)

The value of a metadata tag for a prompt variant.

additionalModelRequestFields -> (document)

Contains model-specific inference configurations that aren’t in the inferenceConfiguration field. To see model-specific inference parameters, see Inference request parameters and response fields for foundation models .

genAiResource -> (tagged union structure)

Specifies a generative AI resource with which to use the prompt.

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

agent -> (structure)

Specifies an Amazon Bedrock agent with which to use the prompt.

agentIdentifier -> (string)

The ARN of the agent with which to use the prompt.

id -> (string)

The unique identifier of the prompt.

arn -> (string)

The Amazon Resource Name (ARN) of the prompt.

version -> (string)

The version of the prompt. When you update a prompt, the version updated is the DRAFT version.

createdAt -> (timestamp)

The time at which the prompt was created.

updatedAt -> (timestamp)

The time at which the prompt was last updated.

Table of Contents

Feedback

User Guide

update-prompt¶

Description¶

Synopsis¶

Options¶

Note

Note

Note

Note

Note

Note

Note

Note

Global Options¶

Output¶

Note

Note

Note

Note

Note

Note

Note

Note