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-agentcore ]

get-recommendation

Description

Retrieves detailed information about a recommendation, including its configuration, status, and results.

See also: AWS API Documentation

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

--recommendation-id (string)

The unique identifier of the recommendation to retrieve.

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

recommendationId -> (string)

The unique identifier of the recommendation.

recommendationArn -> (string)

The Amazon Resource Name (ARN) of the recommendation.

name -> (string)

The name of the recommendation.

description -> (string)

The description of the recommendation.

type -> (string)

The type of recommendation.

recommendationConfig -> (tagged union structure)

The configuration for the recommendation.

Note

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

systemPromptRecommendationConfig -> (structure)

The configuration for a system prompt recommendation.

systemPrompt -> (tagged union structure)

The current system prompt to optimize.

Note

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

text -> (string)

The system prompt text provided inline.

configurationBundle -> (structure)

The system prompt sourced from a configuration bundle version.

bundleArn -> (string)

The Amazon Resource Name (ARN) of the configuration bundle.

versionId -> (string)

The version identifier of the configuration bundle.

systemPromptJsonPath -> (string)

The JSON path within the configuration bundle that contains the system prompt.

agentTraces -> (tagged union structure)

The agent traces to analyze for generating recommendations.

Note

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

sessionSpans -> (list)

Agent traces provided as inline session spans in OpenTelemetry format.

(document)

cloudwatchLogs -> (structure)

Agent traces read from CloudWatch Logs.

logGroupArns -> (list)

The list of CloudWatch log group ARNs to read agent traces from.

(string)

serviceNames -> (list)

The list of service names to filter traces within the specified log groups.

(string)

startTime -> (timestamp)

The start time of the time range to read traces from.

endTime -> (timestamp)

The end time of the time range to read traces from.

rule -> (structure)

Optional rule configuration for filtering traces.

filters -> (list)

The list of filters to apply when reading agent traces.

(structure)

A filter for narrowing down agent traces from CloudWatch Logs based on key-value comparisons.

key -> (string)

The key or field name to filter on within the agent trace data.

operator -> (string)

The comparison operator to use for filtering.

value -> (tagged union structure)

The value to compare against using the specified operator.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: stringValue, doubleValue, booleanValue.

stringValue -> (string)

A string value for text-based filtering.

doubleValue -> (double)

A numeric value for numerical filtering and comparisons.

booleanValue -> (boolean)

A boolean value for true/false filtering conditions.

evaluationConfig -> (structure)

The evaluation configuration specifying which evaluator to use for assessing recommendation quality.

evaluators -> (list)

The list of evaluators to use for assessing recommendation quality.

(structure)

A reference to an evaluator used for recommendation assessment.

evaluatorArn -> (string)

The Amazon Resource Name (ARN) of the evaluator.

toolDescriptionRecommendationConfig -> (structure)

The configuration for a tool description recommendation.

toolDescription -> (tagged union structure)

The current tool descriptions to optimize.

Note

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

toolDescriptionText -> (structure)

Tool descriptions provided as inline text.

tools -> (list)

The list of tool descriptions to optimize.

(structure)

A tool description input containing the tool name and its current description.

toolName -> (string)

The name of the tool.

toolDescription -> (tagged union structure)

The current description of the tool to optimize.

Note

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

text -> (string)

The tool description as inline text.

configurationBundle -> (structure)

Tool descriptions sourced from a configuration bundle version.

bundleArn -> (string)

The Amazon Resource Name (ARN) of the configuration bundle.

versionId -> (string)

The version identifier of the configuration bundle.

tools -> (list)

The list of tool entries mapping tool names to their JSON paths within the bundle.

(structure)

Maps a tool name to its JSON path within a configuration bundle.

toolName -> (string)

The name of the tool.

toolDescriptionJsonPath -> (string)

The JSON path within the configuration bundle’s components that contains the tool description.

agentTraces -> (tagged union structure)

The agent traces to analyze for generating tool description recommendations.

Note

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

sessionSpans -> (list)

Agent traces provided as inline session spans in OpenTelemetry format.

(document)

cloudwatchLogs -> (structure)

Agent traces read from CloudWatch Logs.

logGroupArns -> (list)

The list of CloudWatch log group ARNs to read agent traces from.

(string)

serviceNames -> (list)

The list of service names to filter traces within the specified log groups.

(string)

startTime -> (timestamp)

The start time of the time range to read traces from.

endTime -> (timestamp)

The end time of the time range to read traces from.

rule -> (structure)

Optional rule configuration for filtering traces.

filters -> (list)

The list of filters to apply when reading agent traces.

(structure)

A filter for narrowing down agent traces from CloudWatch Logs based on key-value comparisons.

key -> (string)

The key or field name to filter on within the agent trace data.

operator -> (string)

The comparison operator to use for filtering.

value -> (tagged union structure)

The value to compare against using the specified operator.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: stringValue, doubleValue, booleanValue.

stringValue -> (string)

A string value for text-based filtering.

doubleValue -> (double)

A numeric value for numerical filtering and comparisons.

booleanValue -> (boolean)

A boolean value for true/false filtering conditions.

status -> (string)

The current status of the recommendation.

createdAt -> (timestamp)

The timestamp when the recommendation was created.

updatedAt -> (timestamp)

The timestamp when the recommendation was last updated.

recommendationResult -> (tagged union structure)

The result of the recommendation, containing the optimized system prompt or tool descriptions. Only present when the recommendation status is COMPLETED .

Note

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

systemPromptRecommendationResult -> (structure)

The result of a system prompt recommendation.

recommendedSystemPrompt -> (string)

The optimized system prompt text generated by the recommendation.

configurationBundle -> (structure)

The configuration bundle containing the recommended system prompt, if the input was sourced from a configuration bundle.

bundleArn -> (string)

The Amazon Resource Name (ARN) of the configuration bundle.

versionId -> (string)

The version identifier of the configuration bundle containing the recommendation.

errorCode -> (string)

The error code if the recommendation failed.

errorMessage -> (string)

The error message if the recommendation failed.

toolDescriptionRecommendationResult -> (structure)

The result of a tool description recommendation.

tools -> (list)

The list of tools with their recommended descriptions.

(structure)

The output for a single tool description recommendation.

toolName -> (string)

The name of the tool.

recommendedToolDescription -> (string)

The optimized tool description text generated by the recommendation.

configurationBundle -> (structure)

The configuration bundle containing the recommended tool descriptions, if the input was sourced from a configuration bundle.

bundleArn -> (string)

The Amazon Resource Name (ARN) of the configuration bundle.

versionId -> (string)

The version identifier of the configuration bundle containing the recommendation.

errorCode -> (string)

The error code if the recommendation failed.

errorMessage -> (string)

The error message if the recommendation failed.