<a id="cli-aws-bedrock-agentcore-get-agent-insight"></a>

# get-agent-insight

## Description

Amazon Bedrock AgentCore Agent Insights identifies patterns detected across your agent sessions. Use Agent Insights to identify recurring issues and prioritize fixes.

Retrieves detailed information about an Amazon Bedrock AgentCore Agent Insight, including its archive status, affected sessions, and, when applicable, the batch evaluation that produced it.

See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/GetAgentInsight)

## Synopsis

```
  get-agent-insight
--application-name <value>
--agent-insight-id <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>]
[--help]
```

## Options

`--application-name` (string) [required]

> The application that the Agent Insight belongs to.

> Constraints:

> * min: `1`
> * max: `256`

`--agent-insight-id` (string) [required]

> The unique identifier of the Agent Insight to retrieve.

> Constraints:

> * min: `1`
> * max: `64`
> * pattern: `[a-z0-9]+`

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

`--help` (boolean)

Display help for the command/subcommand.

## Output

type -> (string)

> The type of insight.

> Possible values:

> * `FAILURE`

name -> (string)

> A generated display label for the Agent Insight. This is a human-readable summary of the detected pattern, not an identifier.

> Constraints:

> * min: `1`
> * max: `200`

description -> (string)

> A generated description of the Agent Insight that explains the detected pattern and its observed behavior across sessions.

> Constraints:

> * min: `1`
> * max: `4000`

createdAt -> (timestamp)

> The date and time when the Agent Insight was first created.

affectedSessionCount -> (integer)

> The number of sessions affected by the insight pattern.

> Constraints:

> * min: `0`

sampleSessions -> (list)

> A list of sample sessions that illustrate the Agent Insight, including per-session findings that point to the relevant spans or traces.

> Constraints:

> * min: `0`
> * max: `10`

> (structure)

> > A session affected by an insight or root cause. Use the session ID to find the per-session evaluation results in CloudWatch Logs.

> > sessionId -> (string) [required]

> > > The unique identifier of the session.

> > > Constraints:

> > > * min: `1`
> > > * max: `100`
> > > * pattern: `[a-zA-Z0-9][a-zA-Z0-9-_]*`

> > lastSeenAt -> (timestamp)

> > > The latest timestamp observed for the session in the batch evaluation input.

> > findings -> (list)

> > > The failures found in the session that belong to the insight or root cause, up to 10.

> > > Constraints:

> > > * min: `0`
> > > * max: `10`

> > > (structure)

> > > > A failure found in a session.

> > > > targetId -> (string)

> > > > > The identifier or name of the location in the session where the failure was found, interpreted according to `targetType` .

> > > > > Constraints:

> > > > > * min: `1`
> > > > > * max: `50`

> > > > targetType -> (string)

> > > > > The type of location that `targetId` refers to.

> > > > > Possible values:

> > > > > * `SPAN_ID`
> > > > > * `TRACE_ID`
> > > > > * `SPAN_NAME`

> > > > description -> (string) [required]

> > > > > A description of the failure.

> > > > > Constraints:

> > > > > * min: `1`
> > > > > * max: `500`

> > > > category -> (string)

> > > > > The category of the failure.

> > > > > Constraints:

> > > > > * min: `1`
> > > > > * max: `100`

> > > > confidence -> (double)

> > > > > The confidence that the finding is a failure, from 0 to 1.

> > > > > Constraints:

> > > > > * min: `0`
> > > > > * max: `1`

rootCauses -> (list)

> The root causes identified for the Agent Insight, each with an explanation, an affected session count, an optional suggested fix, and sample sessions that illustrate the root cause.

> Constraints:

> * min: `0`
> * max: `50`

> (structure)

> > A root cause that contributes to an insight.

> > name -> (string) [required]

> > > A generated label for the root cause.

> > > Constraints:

> > > * min: `1`
> > > * max: `200`

> > explanation -> (string) [required]

> > > An explanation of how the root cause leads to the failures in the insight.

> > > Constraints:

> > > * min: `1`
> > > * max: `4000`

> > affectedSessionCount -> (integer)

> > > The number of distinct sessions affected by the root cause. A session can be affected by more than one root cause of the same insight.

> > suggestedFix -> (string)

> > > A suggested change to the agent that addresses the root cause.

> > > Constraints:

> > > * min: `1`
> > > * max: `4000`

> > sampleSessions -> (list)

> > > A sample of up to 10 sessions affected by the root cause.

> > > Constraints:

> > > * min: `0`
> > > * max: `10`

> > > (structure)

> > > > A session affected by an insight or root cause. Use the session ID to find the per-session evaluation results in CloudWatch Logs.

> > > > sessionId -> (string) [required]

> > > > > The unique identifier of the session.

> > > > > Constraints:

> > > > > * min: `1`
> > > > > * max: `100`
> > > > > * pattern: `[a-zA-Z0-9][a-zA-Z0-9-_]*`

> > > > lastSeenAt -> (timestamp)

> > > > > The latest timestamp observed for the session in the batch evaluation input.

> > > > findings -> (list)

> > > > > The failures found in the session that belong to the insight or root cause, up to 10.

> > > > > Constraints:

> > > > > * min: `0`
> > > > > * max: `10`

> > > > > (structure)

> > > > > > A failure found in a session.

> > > > > > targetId -> (string)

> > > > > > > The identifier or name of the location in the session where the failure was found, interpreted according to `targetType` .

> > > > > > > Constraints:

> > > > > > > * min: `1`
> > > > > > > * max: `50`

> > > > > > targetType -> (string)

> > > > > > > The type of location that `targetId` refers to.

> > > > > > > Possible values:

> > > > > > > * `SPAN_ID`
> > > > > > > * `TRACE_ID`
> > > > > > > * `SPAN_NAME`

> > > > > > description -> (string) [required]

> > > > > > > A description of the failure.

> > > > > > > Constraints:

> > > > > > > * min: `1`
> > > > > > > * max: `500`

> > > > > > category -> (string)

> > > > > > > The category of the failure.

> > > > > > > Constraints:

> > > > > > > * min: `1`
> > > > > > > * max: `100`

> > > > > > confidence -> (double)

> > > > > > > The confidence that the finding is a failure, from 0 to 1.

> > > > > > > Constraints:

> > > > > > > * min: `0`
> > > > > > > * max: `1`

agentInsightId -> (string)

> The unique identifier of the Agent Insight.

> Constraints:

> * min: `1`
> * max: `64`
> * pattern: `[a-z0-9]+`

applicationName -> (string)

> The application that the Agent Insight belongs to.

> Constraints:

> * min: `1`
> * max: `256`

batchEvaluationId -> (string)

> The Batch Evaluation that produced this Insight, when applicable.

> Constraints:

> * pattern: `[a-zA-Z][a-zA-Z0-9-_]{0,99}-[a-zA-Z0-9]{10}`

customerMetadataStatus -> (string)

> Specifies whether customer-encrypted metadata is available for the Agent Insight.

> Possible values:

> * `AVAILABLE`
> * `CUSTOMER_KEY_UNAVAILABLE`
> * `UNAVAILABLE`

updatedAt -> (timestamp)

> The date and time when the Agent Insight was last updated.

archiveStatus -> (string)

> Specifies whether the Agent Insight is active or archived. Valid values:

> * `ACTIVE` - The insight is currently active.
> * `ARCHIVED` - The insight has been archived.

> Possible values:

> * `ACTIVE`
> * `ARCHIVED`

lastSeenAt -> (timestamp)

> The most recent date and time when the insight pattern was observed.
