AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . bedrock-agent ]

create-prompt

Description

Creates a prompt in your prompt library that you can add to a flow. For more information, see Prompt management in Amazon Bedrock , Create a prompt using Prompt management and Prompt flows in Amazon Bedrock in the Amazon Bedrock User Guide.

See also: AWS API Documentation

Synopsis

  create-prompt
[--client-token <value>]
[--customer-encryption-key-arn <value>]
[--default-variant <value>]
[--description <value>]
--name <value>
[--tags <value>]
[--variants <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>]

Options

--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. For more information, see Ensuring idempotency .

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

--description (string)

A description for the prompt.

--name (string)

A name for the prompt.

--tags (map)

Any tags that you want to attach to the prompt. For more information, see Tagging resources in Amazon Bedrock .

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

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

--variants (list)

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

(structure)

Contains details about a variant of 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.

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)

temperature -> (float)

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

topK -> (integer)

The number of most-likely candidates that the model considers for the next token during generation.

topP -> (float)

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

modelId -> (string)

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

name -> (string)

The name of the prompt variant.

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.

text -> (structure)

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

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.

text -> (string)

The message for the prompt.

templateType -> (string)

The type of prompt template to use.

JSON Syntax:

[
  {
    "inferenceConfiguration": {
      "text": {
        "maxTokens": integer,
        "stopSequences": ["string", ...],
        "temperature": float,
        "topK": integer,
        "topP": float
      }
    },
    "modelId": "string",
    "name": "string",
    "templateConfiguration": {
      "text": {
        "inputVariables": [
          {
            "name": "string"
          }
          ...
        ],
        "text": "string"
      }
    },
    "templateType": "TEXT"
  }
  ...
]

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

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

Output

arn -> (string)

The Amazon Resource Name (ARN) of the prompt.

createdAt -> (timestamp)

The time at which the prompt was created.

customerEncryptionKeyArn -> (string)

The Amazon Resource Name (ARN) of the KMS key that you encrypted the prompt with.

defaultVariant -> (string)

The name of the default variant for your prompt.

description -> (string)

The description of the prompt.

id -> (string)

The unique identifier of the prompt.

name -> (string)

The name of the prompt.

updatedAt -> (timestamp)

The time at which the prompt was last updated.

variants -> (list)

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

(structure)

Contains details about a variant of 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.

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)

temperature -> (float)

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

topK -> (integer)

The number of most-likely candidates that the model considers for the next token during generation.

topP -> (float)

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

modelId -> (string)

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

name -> (string)

The name of the prompt variant.

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.

text -> (structure)

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

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.

text -> (string)

The message for the prompt.

templateType -> (string)

The type of prompt template to use.

version -> (string)

The version of the prompt. When you create a prompt, the version created is the DRAFT version.