get-recommendation¶

Description¶

Get a specific Recommendation. This API provides global recommendations, eliminating the need to call the API in each AWS Region.

Synopsis¶

  get-recommendation
--recommendation-identifier <value>
[--language <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]

Options¶

--recommendation-identifier (string) [required]

The Recommendation identifier

Constraints:

min: 20

max: 200

pattern: arn:[\w-]+:trustedadvisor::\d{12}:recommendation\/[\w-]+

--language (string)

The ISO 639-1 code for the language that you want your recommendations to appear in.

Possible values:

en

ja

zh

fr

de

ko

zh_TW

it

es

pt_BR

id

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

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

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To get a recommendation

The following get-recommendation example gets a recommendation by its identifier.

aws trustedadvisor get-recommendation \
    --recommendation-identifier arn:aws:trustedadvisor::000000000000:recommendation/55fa4d2e-bbb7-491a-833b-5773e9589578

Output:

{
    "recommendation": {
        "arn": "arn:aws:trustedadvisor::000000000000:recommendation/55fa4d2e-bbb7-491a-833b-5773e9589578",
        "name": "MFA Recommendation",
        "description": "Enable multi-factor authentication",
        "awsServices": [
            "iam"
        ],
        "checkArn": "arn:aws:trustedadvisor:::check/7DAFEmoDos",
        "id": "55fa4d2e-bbb7-491a-833b-5773e9589578",
        "lastUpdatedAt": "2023-11-01T15:57:58.673Z",
        "pillarSpecificAggregates": {
            "costOptimizing": {
                "estimatedMonthlySavings": 0.0,
                "estimatedPercentMonthlySavings": 0.0
            }
        },
        "pillars": [
            "security"
        ],
        "resourcesAggregates": {
            "errorCount": 1,
            "okCount": 0,
            "warningCount": 0
        },
        "source": "ta_check",
        "status": "error",
        "type": "standard"
    }
}

For more information, see Get started with the Trusted Advisor API in the AWS Trusted Advisor User Guide.

Output¶

recommendation -> (structure)

The Recommendation

id -> (string) [required]

The ID which identifies where the Recommendation was produced

type -> (string) [required]

Whether the Recommendation was automated or generated by AWS Trusted Advisor Priority

Possible values:

standard

priority

checkArn -> (string)

The AWS Trusted Advisor Check ARN that relates to the Recommendation

status -> (string) [required]

The status of the Recommendation

Possible values:

ok

warning

error

lifecycleStage -> (string)

The lifecycle stage from AWS Trusted Advisor Priority

Possible values:

in_progress

pending_response

dismissed

resolved

pillars -> (list) [required]

The Pillars that the Recommendation is optimizing

Constraints:

min: 1

max: 50

(string)

Possible values:

cost_optimizing

performance

security

service_limits

fault_tolerance

operational_excellence

source -> (string) [required]

The source of the Recommendation

Possible values:

aws_config

compute_optimizer

cost_explorer

lse

manual

pse

rds

resilience

resilience_hub

security_hub

stir

ta_check

well_architected

cost_optimization_hub

awsServices -> (list)

The AWS Services that the Recommendation applies to

(string)

Constraints:

min: 2

max: 30

name -> (string) [required]

The name of the AWS Trusted Advisor Recommendation

resourcesAggregates -> (structure) [required]

An aggregation of all resources

okCount -> (long) [required]

The number of AWS resources that were flagged to be OK according to the Trusted Advisor check

warningCount -> (long) [required]

The number of AWS resources that were flagged to have warning according to the Trusted Advisor check

errorCount -> (long) [required]

The number of AWS resources that were flagged to have errors according to the Trusted Advisor check

excludedCount -> (long)

The number of AWS resources belonging to this Trusted Advisor check that were excluded by the customer

pillarSpecificAggregates -> (structure)

The pillar aggregations for cost savings

costOptimizing -> (structure)

Cost optimizing aggregates

estimatedMonthlySavings -> (double) [required]

The estimated monthly savings

estimatedPercentMonthlySavings -> (double) [required]

The estimated percently monthly savings

createdAt -> (timestamp)

When the Recommendation was created, if created by AWS Trusted Advisor Priority

lastUpdatedAt -> (timestamp)

When the Recommendation was last updated

arn -> (string) [required]

The ARN of the Recommendation

Constraints:

min: 20

max: 2048

pattern: arn:[\w-]+:trustedadvisor::\d{12}:recommendation\/[\w-]+

statusReason -> (string)

This attribute provides additional details about potential discrepancies in check status determination.

Possible values:

no_data_ok

description -> (string) [required]

A description for AWS Trusted Advisor recommendations

createdBy -> (string)

The creator, if created by AWS Trusted Advisor Priority

updatedOnBehalfOf -> (string)

The person on whose behalf a Technical Account Manager (TAM) updated the recommendation. This information is only available when a Technical Account Manager takes an action on a recommendation managed by AWS Trusted Advisor Priority

updatedOnBehalfOfJobTitle -> (string)

The job title of the person on whose behalf a Technical Account Manager (TAM) updated the recommendation. This information is only available when a Technical Account Manager takes an action on a recommendation managed by AWS Trusted Advisor Priority

updateReason -> (string)

Reason for the lifecycle stage change

Constraints:

min: 10

max: 4096

pattern: [\s\S]*

updateReasonCode -> (string)

Reason code for the lifecycle state change

Possible values:

non_critical_account

temporary_account

valid_business_case

other_methods_available

low_priority

not_applicable

other

resolvedAt -> (timestamp)

When the Recommendation was resolved

Table of Contents

Feedback

User Guide