AWS CLI Command Reference

[ aws . bedrock-agent ]

get-retrieval-instruction

Description

Gets a retrieval instruction. Also used to poll the terminal reporting of an asynchronous create or update.

See also: AWS API Documentation

Synopsis

  get-retrieval-instruction
--retrieval-instruction-id <value>
[--retrieval-instruction-version <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

--retrieval-instruction-id (string) [required]

The identifier of the retrieval instruction to get.

Constraints:

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

--retrieval-instruction-version (string)

The version to return: a version number, or DRAFT for the retrieval instruction’s current reviewed content. When omitted, DRAFT is used. This default is permanent: omitting retrievalInstructionVersion will never resolve to a numbered version.

Constraints:

  • min: 1
  • max: 9
  • pattern: (DRAFT|[1-9][0-9]{0,8})

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

Constraints:

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

retrievalInstructionArn -> (string)

The ARN of the 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)

Specifies whether you can use the instruction. You can resolve only an ACTIVE instruction at retrieval time. Monotone: INACTIVE to ACTIVE once, never back. Numbered versions are always ACTIVE.

Possible values:

  • ACTIVE
  • INACTIVE

lastTransitionStatus -> (string)

The outcome or in-progress state of the most recent create or update. CREATING or UPDATING means the operation is still running. Independent of status. Always has a value from the create 202 onward. On a numbered version this is always CREATE_SUCCESSFUL: a version is created once, from reviewed content, and is immutable.

Possible values:

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

instruction -> (structure)

The reviewed content this instruction serves — what AgenticRetrieveStream resolves while status is ACTIVE. Absent until the first create review passes. Always present on a numbered version.

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

createdAt -> (timestamp)

When the retrieval instruction was created. On a numbered version, when that version was created.

updatedAt -> (timestamp)

When the retrieval instruction was last updated. Equal to createdAt on a numbered version, which is immutable.

description -> (string)

A description of the retrieval instruction. On a numbered version, the description of that version.

Constraints:

  • min: 1
  • max: 200

customerEncryptionKeyArn -> (string)

The ARN of the customer managed KMS key protecting this content, when one was supplied at create.

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}

lastTransitionStatusReasons -> (list)

Why the most recent create or update was rejected. One entry for each rejected field, or a single entry when the review itself failed. Each entry has a machine-readable code and a message, and names the field when it applies to one. The service includes this field only when lastTransitionStatus is CREATE_FAILED or UPDATE_FAILED. Never present on a numbered version.

(structure)

One reason the most recent create or update did not succeed. code drives programmatic branching (fix the text, fix the configuration, or retry); message carries the specific cause.

fieldName -> (string)

The instruction field this entry is about. Present on review rejections of a specific field; absent when the failure applies to the whole review, because a client-side execution failure or a service fault has no single field.

Possible values:

  • RETRIEVAL_GUIDANCE
  • PERSONA
  • ANSWER_FORMAT
  • ANSWER_POLICY

code -> (string) [required]

Stable, machine-readable classification by fault attribution. Valid values:

  • CONTENT_REJECTED – The review rejected the named field’s content; revise the text and resubmit.
  • CLIENT_ERROR – The review could not run for a customer-side reason, for example the customer managed AWS KMS key could not be used; fix the configuration and resubmit.
  • INTERNAL_ERROR – The review could not complete due to a service fault; retry the create or update.

New values may be added over time; your client should tolerate values it does not recognize and treat them as a failure.

Possible values:

  • CONTENT_REJECTED
  • CLIENT_ERROR
  • INTERNAL_ERROR

message -> (string) [required]

Human-readable explanation of the specific cause. Never contains the customer’s own text.

version -> (string)

The version this response describes: a version number, or DRAFT.

Constraints:

  • min: 1
  • max: 9
  • pattern: (DRAFT|[1-9][0-9]{0,8})

latestVersion -> (string)

The largest version number that currently exists for this retrieval instruction, that is, the newest version you can retrieve. Present only on a DRAFT read, and only when at least one version exists. Because version numbers are never reused, deleting versions can leave gaps: this is the newest existing version, not a count and not the highest number ever created.

Constraints:

  • pattern: [1-9][0-9]{0,8}
© Copyright 2026, Amazon Web Services. Created using Sphinx.