AWS CLI Command Reference

[ aws . bedrock-agent ]

create-retrieval-instruction

Description

Creates a new retrieval instruction. The retrieval instruction is usable once its status becomes ACTIVE. Use GetRetrievalInstruction to check whether it is ready.

See also: AWS API Documentation

Synopsis

  create-retrieval-instruction
[--client-token <value>]
--name <value>
--instruction <value>
[--description <value>]
[--customer-encryption-key-arn <value>]
[--tags <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

--client-token (string)

A caller-supplied token that makes a retried create return the existing resource rather than a second one. The window is 8 hours.

Constraints:

  • min: 33
  • max: 256
  • pattern: [a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}

--name (string) [required]

Specifies the name of the retrieval instruction.

Constraints:

  • min: 1
  • max: 100
  • pattern: ([0-9a-zA-Z][_-]?){1,100}

--instruction (structure) [required]

The instruction content, as a set of named fields. Get does not return this field until the create review passes.

retrievalGuidance -> (string)

How to interpret and decompose the question, and what to prioritise when searching.

Constraints:

  • min: 1

persona -> (string)

Who the assistant is: identity, tone and language.

Constraints:

  • min: 1

answerFormat -> (string)

How the answer is structured, including how sources are cited.

Constraints:

  • min: 1

answerPolicy -> (string)

Whether and how to answer: how strongly an answer must be supported, and what to do with questions outside scope.

Constraints:

  • min: 1

Shorthand Syntax:

retrievalGuidance=string,persona=string,answerFormat=string,answerPolicy=string

JSON Syntax:

{
  "retrievalGuidance": "string",
  "persona": "string",
  "answerFormat": "string",
  "answerPolicy": "string"
}

--description (string)

Specifies a description of the retrieval instruction.

Constraints:

  • min: 1
  • max: 200

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

The Amazon Resource Name (ARN) of a customer managed AWS Key Management Service (AWS KMS) key used to encrypt the instruction content at rest. If you omit it, the service uses an AWS owned key. You fix the key at create and cannot change it later.

Constraints:

  • min: 1
  • max: 2048
  • pattern: arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}

--tags (map)

Tags for the retrieval instruction.

key -> (string)

Constraints:

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

value -> (string)

Constraints:

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

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "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

retrievalInstructionId -> (string)

The identifier of the newly created retrieval instruction.

Constraints:

  • min: 10
  • max: 10
  • pattern: [a-z0-9]{10}

retrievalInstructionArn -> (string)

The ARN of the newly created retrieval instruction.

Constraints:

  • pattern: arn:aws(-cn|-us-gov|-eusc|-iso(-[b-f])?)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:retrieval-instruction/[a-z0-9]{10}

name -> (string)

The name of the retrieval instruction.

Constraints:

  • min: 1
  • max: 100
  • pattern: ([0-9a-zA-Z][_-]?){1,100}

status -> (string)

Always INACTIVE on this response. The content review has not run when this call returns, so the resource is not yet usable.

Possible values:

  • ACTIVE
  • INACTIVE

lastTransitionStatus -> (string)

Always CREATING on this response. Poll GetRetrievalInstruction until this member is neither CREATING nor UPDATING, then read the outcome from it.

Possible values:

  • CREATING
  • UPDATING
  • CREATE_SUCCESSFUL
  • CREATE_FAILED
  • UPDATE_SUCCESSFUL
  • UPDATE_FAILED

createdAt -> (timestamp)

When you created the retrieval instruction.

updatedAt -> (timestamp)

When the retrieval instruction was last updated.
© Copyright 2026, Amazon Web Services. Created using Sphinx.