get-agent-recommendation¶

Description¶

Retrieves detailed information about a specific optimization recommendation, including its impact analysis, content, and implementation guidance.

Synopsis¶

  get-agent-recommendation
--recommendation-arn <value>
[--remediation-type <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¶

--recommendation-arn (string) [required]

The Amazon Resource Name (ARN) of the recommendation to retrieve.

Constraints:

min: 0

max: 2048

pattern: arn:aws([a-z0-9-]+)?:wellarchitected:[a-z0-9-]{6,64}:\d{12}:agent-recommendation/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

--remediation-type (string)

Optional filter on remediation type.

Possible values:

AUTO_REMEDIATION

CONSOLE

CLI

SDK

IAC

MCP

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

recommendationArn -> (string)

The Amazon Resource Name (ARN) of the recommendation.

Constraints:

min: 0

max: 2048

pattern: arn:aws([a-z0-9-]+)?:wellarchitected:[a-z0-9-]{6,64}:\d{12}:agent-recommendation/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

profileArn -> (string)

The Amazon Resource Name (ARN) of the associated profile.

Constraints:

min: 0

max: 2048

pattern: arn:aws([a-z0-9-]+)?:wellarchitected:[a-z0-9-]{6,64}:\d{12}:agent-profile/([a-zA-Z0-9_-]+)

title -> (string)

The title of the recommendation.

Constraints:

min: 3

max: 120

description -> (string)

A description of the recommendation.

Constraints:

min: 80

max: 500

type -> (string)

The type of the recommendation.

Possible values:

RESOURCE

ARCHITECTURE

APPLICATION

pillar -> (string)

The Well-Architected Tool Framework pillar that the recommendation addresses.

Possible values:

COST_OPTIMIZATION

SECURITY

RESILIENCE

PERFORMANCE

OPERATIONAL_EXCELLENCE

priority -> (string)

The priority of the recommendation.

Possible values:

HIGH

MEDIUM

LOW

effort -> (string)

The effort required to implement the recommendation.

Possible values:

LARGE

MEDIUM

SMALL

status -> (string)

The current status of the recommendation.

Possible values:

ACTIVE

SUPPRESSED

COMPLETED

state -> (string)

The current state of the recommendation.

Possible values:

OPEN

CLOSED

updateReason -> (string)

The free-text reason associated with the recommendation’s most recent status update.

Constraints:

min: 1

max: 4096

impact -> (string)

The severity of the recommendation’s impact.

Possible values:

HIGH

MEDIUM

LOW

roi -> (structure)

The return on investment estimate for the recommendation.

estimate -> (string)

A short statistic or key metric. Optional when there is no quantifiable figure.

Constraints:

min: 2

max: 40

detail -> (string) [required]

A sentence providing context for the estimate.

Constraints:

min: 30

max: 300

numberOfResources -> (integer)

The number of Amazon Web Services resources this recommendation affects.

awsServices -> (list)

The Amazon Web Services services that the recommendation applies to.

(string)

businessUnits -> (list)

The business units that own the affected resources.

(string)

applications -> (list)

The applications that the recommendation targets.

(string)

impactDetails -> (list)

Detailed impact information for the recommendation.

Constraints:

min: 2

max: 3

(string)

Constraints:

min: 10

max: 100

insights -> (list)

A list of insights about the recommendation.

Constraints:

min: 1

max: 5

(structure)

An insight describing a usage pattern and the signals detected.

usagePattern -> (string) [required]

A description of the usage pattern.

Constraints:

min: 100

max: 2000

signalsDetected -> (string)

A description of the signals detected.

Constraints:

min: 30

max: 1500

highlights -> (list)

Highlights describing what was detected.

Constraints:

min: 1

max: 5

(string)

Constraints:

min: 20

max: 250

remediationSummary -> (structure)

A high-level summary of the recommended remediation.

recommendation -> (string) [required]

A short imperative statement of the recommended action.

Constraints:

min: 80

max: 240

steps -> (list) [required]

High-level steps to implement the fix.

Constraints:

min: 1

max: 5

(string)

Constraints:

min: 20

max: 200

crossPillarBenefits -> (list)

Cross-pillar benefits of acting on the recommendation.

(structure)

A benefit on a different pillar from acting on the recommendation.

pillar -> (string) [required]

The pillar that would be positively impacted.

Possible values:

COST_OPTIMIZATION

SECURITY

RESILIENCE

PERFORMANCE

OPERATIONAL_EXCELLENCE

title -> (string) [required]

A short phrase describing the outcome.

Constraints:

min: 3

max: 80

description -> (string) [required]

A description of what changes and why it matters.

Constraints:

min: 30

max: 300

impact -> (string) [required]

The severity of the benefit.

Possible values:

HIGH

MEDIUM

LOW

tradeOffs -> (list)

Trade-offs of acting on the recommendation.

(structure)

A negative trade-off from acting on the recommendation.

pillar -> (string) [required]

The pillar that could be negatively impacted.

Possible values:

COST_OPTIMIZATION

SECURITY

RESILIENCE

PERFORMANCE

OPERATIONAL_EXCELLENCE

title -> (string) [required]

A short phrase describing what is lost or degraded.

Constraints:

min: 3

max: 80

description -> (string) [required]

A description of the specific risk and the condition that triggers it.

Constraints:

min: 30

max: 450

risk -> (string) [required]

The risk rating for the trade-off.

Possible values:

LOW

MEDIUM

HIGH

mitigation -> (string) [required]

A specific action to mitigate the trade-off and when to take it.

Constraints:

min: 30

max: 450

riskExplanation -> (string)

An optional explanation providing additional context for the risk rating.

Constraints:

min: 1

max: 160

sources -> (list)

Sources that generated this recommendation.

(string)

Possible values:

TRUSTED_ADVISOR

COST_EXPLORER

CLOUDWATCH

WELL_ARCHITECTED_TOOL

WELL_ARCHITECTED_AGENT

CUSTOMER_IAC

goals -> (list)

Goals that this recommendation targets.

(structure)

Contains information about a goal associated with a recommendation.

title -> (string) [required]

The title of the goal associated with the recommendation.

tags -> (list)

A set of key-value pairs associated with the recommendation, used for cost allocation and access control.

(structure)

A key-value pair associated with a resource for cost allocation and access control.

key -> (string) [required]

The key of the tag.

Constraints:

min: 1

max: 128

pattern: [\p{L}\p{Z}\p{N}_.:/=+\-@]+

value -> (string) [required]

The value of the tag.

Constraints:

min: 1

max: 256

pattern: [\p{L}\p{Z}\p{N}_.:/=+\-@]+

createdBy -> (string)

The identifier of the user or system that created this recommendation.

Constraints:

min: 1

max: 128

createdAt -> (timestamp)

The timestamp when the recommendation was created.

lastModifiedBy -> (string)

The identifier of the user or system that last modified this recommendation.

Constraints:

min: 1

max: 128

lastModifiedAt -> (timestamp)

The timestamp when the recommendation was last modified.

remediations -> (list)

A list of remediations for the recommendation.

(structure)

The core fields for a remediation.

recommendationArn -> (string) [required]

The ARN of the recommendation that this remediation belongs to.

Constraints:

min: 0

max: 2048

pattern: arn:aws([a-z0-9-]+)?:wellarchitected:[a-z0-9-]{6,64}:\d{12}:agent-recommendation/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

type -> (string) [required]

The remediation method.

Possible values:

AUTO_REMEDIATION

CONSOLE

CLI

SDK

IAC

MCP

steps -> (list) [required]

The procedural steps to perform the remediation.

Constraints:

min: 1

max: 10

(structure)

One step within a remediation procedure.

title -> (string)

An optional short label for the step.

Constraints:

min: 3

max: 80

content -> (string) [required]

The content describing the step, which can include code examples and verification checklists.

Constraints:

min: 80

max: 8000

resourceLinks -> (list)

External references associated with the steps.

Constraints:

min: 0

max: 10

(structure)

An external reference associated with remediation steps.

url -> (string) [required]

The URL of the external reference.

Constraints:

min: 10

max: 500

title -> (string)

An optional human-readable title for the link.

Constraints:

min: 3

max: 100

createdBy -> (string) [required]

The identifier of the user or system that created this remediation.

Constraints:

min: 1

max: 128

createdAt -> (timestamp) [required]

The timestamp when the remediation was created.

lastModifiedBy -> (string)

The identifier of the user or system that last modified this remediation.

Constraints:

min: 1

max: 128

lastModifiedAt -> (timestamp)

The timestamp when the remediation was last modified.

Table of Contents

Feedback

User Guide